JugiMap Framework
AnimationPlayerFlags Struct Reference

The bit-mask flags of animation player. More...

#include <jmGlobal.h>

Static Public Attributes

static const int NONE = 0
 None. More...
 
static const int DISCARD_ANIMATION_QUEUE = 1
 Stop and discard animations in queue and start the new animation immediately. This is an input flag for AnimationQueuePlayer::Play. More...
 
static const int SKIP_SUBPLAYER_UPDATING = 2
 Not available. More...
 
static const int PLAYER_STARTED = 1
 The return flag for AnimationQueuePlayer::Play command. If the player already plays the given animation this flag is not returned. More...
 
static const int PLAYER_UPDATED = 2
 The return flag for AnimationQueuePlayer::Update command. If the player is in the in the idle state this flag is not returned. More...
 
static const int PLAYER_STOPPED = 4
 The return flag for AnimationQueuePlayer::Stop command. If the player is already in the idle state this flag is not returned. More...
 
static const int ANIMATION_INSTANCE_UPDATED = 8
 The return flag for AnimationQueuePlayer::Play and AnimationQueuePlayer::Update commands when the animation update has been performed. More...
 
static const int ANIMATED_PROPERTIES_CHANGED = 16
 The return flag for AnimationQueuePlayer::Play and AnimationQueuePlayer::Update commands when the animated properties have been changed. More...
 
static const int META_KEY_CHANGED = 32
 The return flag for AnimationQueuePlayer::Play and AnimationQueuePlayer::Update commands when the meta animation key changes. More...
 

Detailed Description

The bit-mask flags of animation player.

Member Data Documentation

◆ NONE

const int NONE = 0
static

None.

◆ DISCARD_ANIMATION_QUEUE

const int DISCARD_ANIMATION_QUEUE = 1
static

Stop and discard animations in queue and start the new animation immediately. This is an input flag for AnimationQueuePlayer::Play.

◆ SKIP_SUBPLAYER_UPDATING

const int SKIP_SUBPLAYER_UPDATING = 2
static

Not available.

◆ PLAYER_STARTED

const int PLAYER_STARTED = 1
static

The return flag for AnimationQueuePlayer::Play command. If the player already plays the given animation this flag is not returned.

◆ PLAYER_UPDATED

const int PLAYER_UPDATED = 2
static

The return flag for AnimationQueuePlayer::Update command. If the player is in the in the idle state this flag is not returned.

◆ PLAYER_STOPPED

const int PLAYER_STOPPED = 4
static

The return flag for AnimationQueuePlayer::Stop command. If the player is already in the idle state this flag is not returned.

◆ ANIMATION_INSTANCE_UPDATED

const int ANIMATION_INSTANCE_UPDATED = 8
static

The return flag for AnimationQueuePlayer::Play and AnimationQueuePlayer::Update commands when the animation update has been performed.

◆ ANIMATED_PROPERTIES_CHANGED

const int ANIMATED_PROPERTIES_CHANGED = 16
static

The return flag for AnimationQueuePlayer::Play and AnimationQueuePlayer::Update commands when the animated properties have been changed.

◆ META_KEY_CHANGED

const int META_KEY_CHANGED = 32
static

The return flag for AnimationQueuePlayer::Play and AnimationQueuePlayer::Update commands when the meta animation key changes.


The documentation for this struct was generated from the following file: