[AnimationSetTemplate] Frequency = <Float> KeepInCache = <Bool> StartAnim = Animation Prefix = <String> string Digits = <Int> Animation = [String] # [Int] Animation = [String] # [String] Animation-> = {.!+-}Animation1 # {.!+-}Animation2 # ...
[AnimationTemplate] Texture = path/to/ImageFile.ext TextureOrigin = <Vector> TextureSize = <Vector> Direction = left|right|down|up # left|right|down|up FrameSize = <Vector> KeyDuration = <Float> [AnimationTemplate<N>] ; eg: AnimationTemplate0003 KeyEvent = [String] # <Float> TextureOrigin = <Vector> TextureSize = <Vector> KeyDuration = <Float>
This AnimationSet
section will become the parent of any Animation
section used by it. So they will become common properties to all the animations or animation frames. Properties such as FrameSize
, Texture
, KeyDuration
or Direction
can be defined here.
Here's a list of the available properties for an animation set:
Frequency
: Relative frequency to which the animations will be played. Defaults to 1.0, which means the animation will be played with the timing defined in the config.KeepInCache
: If true, the animation set will always stay in cache, even if not currently used by any objects. Can save time but costs memory. Defaults to false.StartAnim
: Name of the entry point of the animation graph, first animation to be played by default.Prefix
: String prefix that will used in front of all animation names and frames. Defaults to empty string.Digits
: How many digits will be used for the animation frame suffixes, ie: 0001. Defaults to 4..
means: immediate, !
means: clear target, +
means: high priority, -
means: low priority.NB: Do not use manual inheritance at the section level as it will be overridden at runtime; it's parent will then become the animation set section.
Here's a list of the available properties for an animation:
Texture
: path/to/ImageFile.extTextureOrigin
: Defines the origin of the texture from which to get the frames. Defaults to top left corner, ie. (0, 0, 0)TextureSize
: Defines the size of the texture from which to get the frames. Defaults to the actual physical size of the textureDirection
: Defines how the frames are read inside the texture. First value defines the direction of the rows, second one the direction of the columns. Defaults to right # down (ie. western writing direction). Examples: left|right|down|up # left|right|down|upFrameSize
: Default size of all the frames of this animationKeyDuration
: Default key duration for all the frames of this animationFor example: Animation0004 or Animation0005 etc
NB: Do not use manual inheritance at the section level as it will be overridden at runtime: its parent will then become the animation section.
Here's a list of the available properties for an animation frame override:
KeyEvent
: Optional. Defines a custom event that will be sent when this key is played. The first value is the event's name, the second one, the event's numerical value, which is optional and defaults to 0.0.TextureOrigin
: Optional. Overrides the computed origin of the frame. Only define it for manual override.TextureSize
: Optional. Overrides the default size of the frame (the FrameSize attribute in the animation/Animation Set). Only define it for manual override.KeyDuration
: Optional. Overrides the default key duration of the frame.Examples:
See: Animation Walk-through.
You can listen to the orxEVENT_TYPE_ANIM
events if you still want to be notified when transitions occur.
Between two animations, the calculated path will take the highest priority links at each step and if two links with the same priority are found, it will then take the one that leads to the shortest path (ie. the least amount of links needed to reach destination).
NB: If you don't feel at ease with this graph system, you can still define all your animations separately and then do all the transitions manually every time the current animation has been completely played (listening to the orxANIM_EVENT_STOP
event, for example).
We endeavor to keep the config properties on this page up to date as often as possible. For up to the minute config information for the latest version of Orx, check the most recent published at:
Additionally these files can be found under your orx source tree in the orx/code/bin
folder.