StopAnim: Difference between revisions
Document 0.1.4 expanded animation catalog and Lua metadata APIs; confirmed in-game |
Document upcoming 0.1.9 activity animations: 844 aliases, fishing, player/NPC Lua usage and qualification; not a release |
||
| Line 37: | Line 37: | ||
[[Category:Server Functions]] | [[Category:Server Functions]] | ||
[[Category:Animation Functions]] | [[Category:Animation Functions]] | ||
<!-- activities019:start --> | |||
== Activity cleanup from 0.1.9 == | |||
'''Available from 0.1.9 (upcoming; not yet publicly released).''' Not included in public 0.1.8. Both the server and observing clients need the matching update. | |||
Also ends the new [[Activity animations|activity animations and held fishing poses]] and retires their animation-owned cosmetic props. Use <code>stopAnim(playerId)</code>; no new argument is required. It does not remove inventory rods/weapons, furniture or unrelated world objects. | |||
<!-- activities019:end --> | |||
Revision as of 09:18, 19 October 2026
stopAnim
Stops the tracked scripted visual animation for a connected player and synchronizes the stop with relevant clients.
Syntax
bool stopAnim(int playerId)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | The connected player identifier. |
Returns
Returns true when the server records or retransmits the authoritative stopped state and attempts reliable delivery. This is not a client or transport acknowledgement. Returns false for an invalid player or inactive player session.
Examples
Stop a scripted animation:
stopAnim(playerId)
Notes
- Since 0.1.4 BUILD127, this also stops the new entries in the Player animation catalog and retires their owned cosmetic props. It does not delete equipped weapons, inventory items or unrelated world objects.
- Available only in server-side resource scripts.
- This stops only the scripted animation tracked by
startAnim; it does not issue a global montage stop and does not cancel normal replicated locomotion, combat, interaction, hit, or death state. - Calling
stopAnimafter an accepted start also supersedes any still-pending client asset load for that older animation state.
Activity cleanup from 0.1.9
Available from 0.1.9 (upcoming; not yet publicly released). Not included in public 0.1.8. Both the server and observing clients need the matching update.
Also ends the new activity animations and held fishing poses and retires their animation-owned cosmetic props. Use stopAnim(playerId); no new argument is required. It does not remove inventory rods/weapons, furniture or unrelated world objects.