Difference between revisions of "PlayGroup"
Jump to navigation
Jump to search
imported>Omzy m |
imported>Qazaaq m (updating to use function template) |
||
| Line 1: | Line 1: | ||
== | {{Function | ||
|name = PlayGroup | |||
'''PlayGroup''' plays an animation group on the calling actor. See [[AnimGroups]] for a list of possible animations. | |origin = GECK1 | ||
|summary = '''PlayGroup''' plays an animation group on the calling actor. See [[AnimGroups]] for a list of possible animations. | |||
Optional flags can be used to start the group in different ways. | Optional flags can be used to start the group in different ways. | ||
| Line 8: | Line 9: | ||
:0 = Normal - The current animation will finish it's full cycle, and the new animation will start from its beginning. | :0 = Normal - The current animation will finish it's full cycle, and the new animation will start from its beginning. | ||
:1 = Immediate Start - The current animation will stop regardless of the frame it is on, and the new animation will start from its beginning. | :1 = Immediate Start - The current animation will stop regardless of the frame it is on, and the new animation will start from its beginning. | ||
:2 = Immediate Loop -The current animation will stop regardless of the frame it is on, and the new animation will start at the beginning of its loop cycle. | :2 = Immediate Loop -The current animation will stop regardless of the frame it is on, and the new animation will start at the beginning of its loop cycle. | ||
|referenceType = Actor | |||
|arguments = {{FunctionArgument | |||
== | |Name = AnimGroup | ||
|Type = string | |||
}}{{FunctionArgument | |||
|Name = Flags | |||
|Type = int | |||
== | |Value = 0, 1, 2 | ||
|Optional = y | |||
}} | |||
|example = | |||
PlayGroup AttackPower | |||
PlayGroup AttackPower 1 | |||
}} | |||
==Notes== | |||
*Animations may be viewed in the GECK by navigating to the animation tab of the NPC window. Clicking on a .kf file will play the desired animation group. | *Animations may be viewed in the GECK by navigating to the animation tab of the NPC window. Clicking on a .kf file will play the desired animation group. | ||
*Playing some animations on the Player or other NPCs can cause the actor to engage in abnormal behavior. These may be characterized by freezing in place, running backwards, walking through solid objects, being unable to attack, etc. Using ''PlayGroup Idle 1'' will return the actor to normal user function. | *Playing some animations on the Player or other NPCs can cause the actor to engage in abnormal behavior. These may be characterized by freezing in place, running backwards, walking through solid objects, being unable to attack, etc. Using ''PlayGroup Idle 1'' will return the actor to normal user function. | ||
*Some animation groups are only available under certain conditions. In particular, combat animations like Recoil will only be played if the actor has a weapon drawn. | *Some animation groups are only available under certain conditions. In particular, combat animations like Recoil will only be played if the actor has a weapon drawn. | ||
*The Stagger group is listed in [[AnimGroups]] but no .kf files are associated with it in the editor, meaning that it does not function. Instead, use PlayIdle to play a ''hit reaction'' idle. | *The Stagger group is listed in [[AnimGroups]] but no .kf files are associated with it in the editor, meaning that it does not function. Instead, use PlayIdle to play a ''hit reaction'' idle. | ||
Revision as of 08:31, 26 July 2009
< [[::Category:Functions|Category:Functions]]
A function included in the GECK version 1.1.0.36.
Description
PlayGroup plays an animation group on the calling actor. See AnimGroups for a list of possible animations.
Optional flags can be used to start the group in different ways.
Flags
- 0 = Normal - The current animation will finish it's full cycle, and the new animation will start from its beginning.
- 1 = Immediate Start - The current animation will stop regardless of the frame it is on, and the new animation will start from its beginning.
- 2 = Immediate Loop -The current animation will stop regardless of the frame it is on, and the new animation will start at the beginning of its loop cycle.
Syntax
Actor.PlayGroup AnimGroup:string Flags:int{0, 1, 2}
Example
PlayGroup AttackPower PlayGroup AttackPower 1
Notes
- Animations may be viewed in the GECK by navigating to the animation tab of the NPC window. Clicking on a .kf file will play the desired animation group.
- Playing some animations on the Player or other NPCs can cause the actor to engage in abnormal behavior. These may be characterized by freezing in place, running backwards, walking through solid objects, being unable to attack, etc. Using PlayGroup Idle 1 will return the actor to normal user function.
- Some animation groups are only available under certain conditions. In particular, combat animations like Recoil will only be played if the actor has a weapon drawn.
- The Stagger group is listed in AnimGroups but no .kf files are associated with it in the editor, meaning that it does not function. Instead, use PlayIdle to play a hit reaction idle.
See Also