A global resource that comes in multiple flavors and can be use by multiple resources simultaneously.

See Also

Static Variables

Name Description

uid Global unique id to identify the asset.

Declaration

unsigned int uid

links Amount of references the asset currently have (connected to how many resources).

Declaration

unsigned int links

data Internal data structure of the Asset maintaining the data available for its type.

Declaration

AssetData data

flags Bit mask holding the current state of the Asset.

Declaration

int flags

Cap	Value	Description
`AST_FLAG_LOADING`	`bit.lshift(1,0)`	The Asset is currently loading.
`AST_FLAG_UNLOADING`	`bit.lshift(1,1)`	The Asset is marked to be unloaded.
`AST_FLAG_DIRTY`	`bit.lshift(1,2)`	The Asset is marked as to be saved.
`AST_FLAG_REGION`	`bit.lshift(1,3)`	The Asset have been loaded dynamically by a Region (Scene only).

Variables

Name Description

name The fullpath of the Asset starting from the project root.

Declaration

char *name

AssetType

Defines the data type of an Asset.

kScene: A container where you can place objects to create worlds.
kTexture: Base type that can be mutated into multiple subtype of texture such as 2d, 3d, Video, Font etc...
kCubemap: A cubemap texture where that uses a different Texture on every face.
kMaterial: Structure that will prepare the ncessary resources for the GPU to draw triangles.
kPhysicMaterial: Controls the surface properties of a physic object.
kSoundBuffer: The binary data that will be streamed at runtime by a SoundSource.
kVideoBuffer: Provide the binary video data that will update a video Texture at runtime.
kMesh: Geometric binary data that defines the topology of renderable objects.
kSkeleton: Hierarchy of bones and joint that defines how a skin move when beeing animated.
kScript: Where you place your logic code.
kShader: Code that tells the GPU how to draw triangles.
kTrack: A reusable curve.
kUtility: Basically a Script to create tools for the editor.
kEntity: A fully functional object that is reusable (a prefab).
kFracture: Prefedine how an mesh should shater.
kParticleNetwork: Define how particles contained inside a particle system behave.
kPath: A 3d dimensional route that consists of tri-dimensional control points.
kAudioEffect: Simulate real world acoustic and psychoacoustic effects by modulating the final audio mixer output.
kAudioFilter: Attenuates various frequencies of a specific sound of the final output in realtime.
kArmature: An armature is used by actions and activity strips to exclude or include a specific set of bones from an animation.
kController: Controls the flow of an animation using predefined machine states.

Example

Lua
 -- You can access a specific asset type like this:
    print( "The value of the AssetType kTexture is " .. Asset.AssetType.kTexture )

MiscType

Miscellaneous type that are neither associated to an Asset or an Object; the list below are used to identity non-resource types (possible type used by an Handler).

kApplication: Application identifier.
kAsset: Asset identifier;
kObject: Object identifier;
kAction: Action identifier.
kChannel: Channel identifier.
kParticleEmitter: ParticleEmitter identifier.
kSequence: Sequence identifier.
kActionController: ActionController identifier.

AssetData

Internal structure that maintain the data of the Asset based on the type it was created with.

Static Variables

Name	Description
`type`	The internal AssetType of the Asset.
Declaration AssetType type
`scene`	Scene data reference.
Declaration Scene *scene `nil` if the asset data `type` is not `kScene`.
`texture`	Texture data reference.
Declaration Texture *texture `nil` if the asset data `type` is not `kTexture`.
`cubemap`	Cubemap data reference.
Declaration Cubemap *cubemap `nil` if the asset data `type` is not `kCubemap`.
`material`	Material data reference.
Declaration Material *material `nil` if the asset data `type` is not `kMaterial`.
`physicmaterial`	PhysicMaterial data reference.
Declaration PhysicMaterial *physicmaterial `nil` if the asset data `type` is not `kPhysicMaterial`.
`soundbuffer`	SoundBuffer data reference.
Declaration SoundBuffer *soundbuffer `nil` if the asset data `type` is not `kSoundBuffer`.
`videobuffer`	VideoBuffer data reference.
Declaration VideoBuffer *videobuffer `nil` if the asset data `type` is not `kPhysicMaterial`.
`mesh`	Mesh data reference.
Declaration Mesh *mesh `nil` if the asset data `type` is not `kMesh`.
`skeleton`	Skeleton data reference.
Declaration Skeleton *skeleton `nil` if the asset data `type` is not `kSkeleton`.
`mesh`	Mesh data reference.
Declaration Mesh *mesh `nil` if the asset data `type` is not `kMesh`.
`skeleton`	Skeleton data reference.
Declaration Skeleton *skeleton `nil` if the asset data `type` is not `kSkeleton`.
`script`	Script data reference.
Declaration Script *script `nil` if the asset data `type` is not `kScript`.
`shader`	Shader data reference.
Declaration Shader *shader `nil` if the asset data `type` is not `kShader`.
`track`	Track data reference.
Declaration Track *track `nil` if the asset data `type` is not `kTrack`.
`fracture`	Fracture data reference.
Declaration Fracture *fracture `nil` if the asset data `type` is not `kFracture`.
`particlenetwork`	ParticleNetwork data reference.
Declaration ParticleNetwork *particlenetwork `nil` if the asset data `type` is not `kParticleNetwork`.
`path`	Path data reference.
Declaration Path *path `nil` if the asset data `type` is not `kPath`.
`audioeffect`	AudioEffect data reference.
Declaration AudioEffect *audioeffect `nil` if the asset data `type` is not `kAudioEffect`.
`audiofilter`	AudioFilter data reference.
Declaration AudioFilter *audiofilter `nil` if the asset data `type` is not `kAudioFilter`.
`armature`	Armature data reference.
Declaration Armature *armature `nil` if the asset data `type` is not `kArmature`.
`controller`	Controller data reference.
Declaration Controller *controller `nil` if the asset data `type` is not `kController`.