Osiris/API/PlayAnimation - Revision history

Tinkerer at 21:37, 9 April 2019

2019-04-09T21:37:31Z

← Older revision		Revision as of 21:37, 9 April 2019
Line 6:		Line 6:
	* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races for which they are available.		* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races for which they are available.
	* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.		* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.
	* This call ~~work~~ for both looping and non-looping animations, but looping animations will play only once. Animations set through this call override/interrupt looping animations set via [[Osiris/API/CharacterSetAnimationOverride\|CharacterSetAnimationOverride]].		* This call works for both looping and non-looping animations, but looping animations will play only once. Animations set through this call override/interrupt looping animations set via [[Osiris/API/CharacterSetAnimationOverride\|CharacterSetAnimationOverride]].
	* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.		* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.

Tinkerer at 09:47, 15 August 2018

2018-08-15T09:47:54Z

← Older revision		Revision as of 09:47, 15 August 2018
Line 6:		Line 6:
	* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races for which they are available.		* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races for which they are available.
	* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.		* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.
	* This call work for both looping and non-looping animations. Animations set through this call override looping animations set via [[Osiris/API/CharacterSetAnimationOverride\|CharacterSetAnimationOverride]].		* This call work for both looping and non-looping animations, but looping animations will play only once. Animations set through this call override/interrupt looping animations set via [[Osiris/API/CharacterSetAnimationOverride\|CharacterSetAnimationOverride]].
	* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.		* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.

DerCapac at 18:35, 14 August 2018

2018-08-14T18:35:30Z

← Older revision		Revision as of 18:35, 14 August 2018
Line 6:		Line 6:
	* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races for which they are available.		* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races for which they are available.
	* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.		* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.
	* This call work for both looping and non-looping animations. Animations set through this call override looping animations set via [[Osiris/API/~~SetAnimationOverride~~\|~~SetAnimationOverride~~]].		* This call work for both looping and non-looping animations. Animations set through this call override looping animations set via [[Osiris/API/CharacterSetAnimationOverride\|CharacterSetAnimationOverride]].
	* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.		* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.

Tinkerer: PlayAnimation also supports looping animations

2018-06-20T15:49:14Z

PlayAnimation also supports looping animations

← Older revision		Revision as of 15:49, 20 June 2018
Line 6:		Line 6:
	* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races for which they are available.		* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races for which they are available.
	* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.		* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.
	* This call ~~is only supported~~ for non-looping animations. ~~Use~~ [[Osiris/API/SetAnimationOverride\|SetAnimationOverride]] ~~to play looping animations~~.		* This call work for both looping and non-looping animations. Animations set through this call override looping animations set via [[Osiris/API/SetAnimationOverride\|SetAnimationOverride]].
	* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.		* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.

Tinkerer at 15:24, 19 December 2017

2017-12-19T15:24:23Z

← Older revision		Revision as of 15:24, 19 December 2017
Line 13:		Line 13:
	* [[Osiris/API/StoryEvent\|StoryEvent]]		* [[Osiris/API/StoryEvent\|StoryEvent]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls\|PlayAnimation]]

Tinkerer: /* Notes */ Wording

2017-10-15T08:53:41Z

Notes: Wording

← Older revision		Revision as of 08:53, 15 October 2017
Line 4:		Line 4:
	Plays the animation with [[Visual_resource_panel\|simple name]] '''_Animation''' on '''_SourceObject'''. Once the animation has finished playing, the event '''_Event''' will be thrown.		Plays the animation with [[Visual_resource_panel\|simple name]] '''_Animation''' on '''_SourceObject'''. Once the animation has finished playing, the event '''_Event''' will be thrown.
	===== Notes =====		===== Notes =====
	* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races they are available to.		* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races for which they are available.
	* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.		* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.
	* This call is only supported for non-looping animations. Use [[Osiris/API/SetAnimationOverride\|SetAnimationOverride]] to play looping animations.		* This call is only supported for non-looping animations. Use [[Osiris/API/SetAnimationOverride\|SetAnimationOverride]] to play looping animations.
	* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.		* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.

	===== See Also =====		===== See Also =====
	* [[Osiris/API/SetAnimationOverride\|SetAnimationOverride]]		* [[Osiris/API/SetAnimationOverride\|SetAnimationOverride]]

Tinkerer at 19:26, 14 October 2017

2017-10-14T19:26:41Z

← Older revision		Revision as of 19:26, 14 October 2017
Line 6:		Line 6:
	* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races they are available to.		* We have a [[Standard_Character_Animations\|list]] of simple names of character animations and the playable races they are available to.
	* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.		* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries\|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.
	* This call is only supported for non-looping animations.		* This call is only supported for non-looping animations. Use [[Osiris/API/SetAnimationOverride\|SetAnimationOverride]] to play looping animations.
	* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.		* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.
	===== See Also =====		===== See Also =====

Tinkerer: Documented PlayAnimation

2017-10-14T19:26:11Z

Documented PlayAnimation

New page

===== Full Definition(s) =====
* call '''PlayAnimation'''(''(GUIDSTRING)'''''_SourceObject''', ''(STRING)'''''_Animation''', ''(STRING)'''''_Event''')
===== Description =====
Plays the animation with [[Visual_resource_panel|simple name]] '''_Animation''' on '''_SourceObject'''. Once the animation has finished playing, the event '''_Event''' will be thrown.
===== Notes =====
* We have a [[Standard_Character_Animations|list]] of simple names of character animations and the playable races they are available to.
* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.
* This call is only supported for non-looping animations.
* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.
===== See Also =====
* [[Osiris/API/SetAnimationOverride|SetAnimationOverride]]
* [[Osiris/API/StoryEvent|StoryEvent]]

[[Category:Osiris Calls]]