animations/meta/sh_player¶
Source: gamemode/modules/animations/meta/sh_player.lua
Returns the player's translated animation hold type.
Documented functions: 3
Functions¶
ax.animations:ApplyForcedSequenceTiming(client, sequence, sequenceTime)ax.animations:ClearForcedSequencePending(client)ax.animations:ResolveForcedSequencePending(client, serial, sequenceTime)
ax.animations:ApplyForcedSequenceTiming(client, sequence, sequenceTime)¶
Applies timing behavior for a forced sequence on a player.
Non-zero sequence times create an automatic leave timer. A zero time marks the sequence as looping until the player cancels it.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
client |
Player |
The player currently in the forced sequence. |
sequence |
string\|number |
The sequence identifier, used for debug output. |
sequenceTime |
number |
Duration in seconds. Use 0 for a looping/cancellable sequence. |
Returns
number: The normalized sequence duration in seconds.
ax.animations:ClearForcedSequencePending(client)¶
Clears any pending client-authoritative sequence resolution for a player.
Removes the stored pending resolve entry and its timeout timer.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
client |
Player |
The player whose pending forced sequence resolve should be cleared. |
ax.animations:ResolveForcedSequencePending(client, serial, sequenceTime)¶
Resolves a pending forced sequence timing request from the client.
Validates the pending serial and current sequence identifier to ignore stale or mismatched responses.
On success, clears the pending entry and applies the supplied sequence timing.
Realm: server
Parameters
| Name | Type | Description |
|---|---|---|
client |
Player |
The player that resolved the sequence. |
serial |
number |
The forced sequence serial sent to the client. |
sequenceTime |
number |
Resolved duration in seconds. |
Returns
boolean: True if the pending resolve was accepted.number|string: Applied sequence time on success, or an error message on failure.