[This is preliminary documentation and is subject to change.]
Represents an animation task. This class cannot be inherited.
Inheritance Hierarchy
RageTask
RageAnimationTask
Namespace: Rage
Assembly: RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
Syntax
The AnimationTask type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| AnimationDictionary | ||
| AnimationName | ||
| CurrentTime |
Gets or sets the current time of the animation being played by this task, in seconds.
| |
| CurrentTimeRatio |
Gets or sets the current time ratio of the animation being played by this task.
| |
| IsActive | Gets a value indicating whether this task is active. A task is considered active if its status is not None. | |
| IsPlaying | Gets a value indicating whether the animation represented by this task is currently playing. | |
| Length |
Gets the length of the animation represented by this task, in seconds.
| |
| Name |
Gets the name of the method that was used to invoke this task. Eg. "RappelFromHelicopter".
(Inherited from Task.) | |
| Ped |
Gets the Ped this task is assigned to.
(Inherited from Task.) | |
| PlayRate |
Sets the speed multiplier of the animation being played by this task.
| |
| RemainingTimeRatio |
Gets or sets the remaining time ratio of the animation being played by this task.
| |
| Status |
Gets the current status of this task.
(Inherited from Task.) |
Methods
| Name | Description | |
|---|---|---|
| WaitForCompletion |
Sleeps the active GameFiber until the task completes.
(Inherited from Task.) | |
| WaitForCompletion(Int32) |
Sleeps the active GameFiber until the task completes.
(Inherited from Task.) | |
| WaitForStatus(TaskStatus) |
Sleeps the active GameFiber until the task reaches the specified status.
(Inherited from Task.) | |
| WaitForStatus(TaskStatus, Int32) |
Sleeps the active GameFiber until the task reaches the specified status.
(Inherited from Task.) |
See Also