Platform SDK: Agent

IdleOn Property

Description
Returns or sets a Boolean value that determines whether the server manages the specified character's Idling state animations.
Syntax
agent.Characters ("CharacterID").IdleOn [ = boolean]

Part Description
boolean A Boolean expression specifying whether the server manages idle mode.

True (Default) Server handling of the idle state is enabled.

False Server handling of the idle state is disabled.


Remarks

The server automatically sets a time-out after the last animation played for a character. When this timer's interval is complete, the server begins the Idling state for a character, playing its associated Idling animations at regular intervals. If you want to disable the server from automatically playing the Idling state animations, set the property to False and play an animation or call the Stop method. Setting this value does not affect the current animation state of the character.

This property applies only to your client application's use of the character; the setting does not affect other clients of the character or other characters of your client application.