QCherry: Add the player animation catalog for update 0.1.2

2026-09-04T16:21:10Z

Add the player animation catalog for update 0.1.2

New page

{{DISPLAYTITLE:Player animation catalog}}
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.2</div>
<div style="color:#111111; margin-top:0.25rem;">The 27-entry player-animation catalog and the synchronized [[startAnim]] and [[stopAnim]] behavior are available from G1R:MP 0.1.2.</div>
</div>

The '''player animation catalog''' lists the stable, server-validated aliases accepted by [[startAnim]]. Aliases are case-insensitive. Lua passes an alias from this table; raw Unreal asset paths are neither accepted nor exposed as API inputs.

== Request modes ==
The '''authored mode''' documents the safe, recommended presentation for each animation. It does not change the compatible Lua signature:

* Omitting <code>looped</code> from [[startAnim]] always means <code>false</code>, including for entries whose authored mode is <code>hold</code>.
* With <code>looped = false</code>, the animation plays once from its beginning and ends naturally. Use this for every <code>once</code> entry.
* With <code>looped = true</code>, a <code>hold</code> entry plays its introduction, then repeats from the catalogued loop-start time until [[stopAnim]] or a newer scripted animation supersedes it. Higher-priority gameplay presentation temporarily takes precedence; the same active scripted revision may resume afterward.
* The optional blend duration controls the owning player's native montage transition when the request replaces an existing scripted animation, then remains the stop blend for the new animation. Remote proxy handoff is immediate and does not guarantee an interpolated blend.
* A loop-start value is native catalog metadata. It is not an additional Lua argument.

== Available aliases ==
{| class="wikitable sortable"
! Key !! Description !! Authored mode !! Loop start !! Notes
|-
| <code>crossarms</code> || Stand with arms crossed. || <code>hold</code> || <code>3.47 s</code> ||
|-
| <code>pray</code> || Pray while standing. || <code>hold</code> || <code>6.83 s</code> ||
|-
| <code>meditate</code> || Perform a standing meditation pose. || <code>hold</code> || <code>11.5 s</code> ||
|-
| <code>warmhands</code> || Warm the hands in a cold or rainy standing pose. || <code>hold</code> || <code>0.93 s</code> || Uses the stable Rain Pose 04 replacement; the unsafe original Warm Hands montage is not exposed.
|-
| <code>exhausted</code> || Show an exhausted standing pose. || <code>hold</code> || <code>9.47 s</code> ||
|-
| <code>dance</code> || Perform a standing dance. || <code>hold</code> || <code>1.97 s</code> ||
|-
| <code>smalltalk</code> || Gesture while speaking to an audience. || <code>hold</code> || <code>4.5 s</code> || Uses the visible Speaks Audience replacement; the original non-rendering Small Talk montage is not exposed.
|-
| <code>guard</code> || Hold a watchful guard pose with crossed arms. || <code>hold</code> || <code>3.47 s</code> ||
|-
| <code>sitground</code> || Sit on the ground. || <code>hold</code> || <code>5.03 s</code> ||
|-
| <code>sleepground</code> || Lie down and sleep on the ground. || <code>once</code> || — ||
|-
| <code>sleepstand</code> || Doze while standing. || <code>hold</code> || <code>4.17 s</code> ||
|-
| <code>leanwall</code> || Lean against a wall. || <code>hold</code> || <code>3 s</code> ||
|-
| <code>listen</code> || Adopt a listening pose. || <code>hold</code> || <code>2.57 s</code> ||
|-
| <code>waterpipe</code> || Use a water pipe. || <code>hold</code> || <code>8.67 s</code> ||
|-
| <code>smoke</code> || Perform the standing smoking pose. || <code>hold</code> || <code>1.47 s</code> ||
|-
| <code>campfire</code> || Warm up in front of a campfire. || <code>hold</code> || <code>4.73 s</code> ||
|-
| <code>puke</code> || Perform the vomiting animation. || <code>once</code> || — ||
|-
| <code>angrydrunk</code> || Act like an angry drunk. || <code>hold</code> || <code>3.67 s</code> ||
|-
| <code>airguitar</code> || Perform the concert air-guitar pose. || <code>hold</code> || <code>0.03 s</code> ||
|-
| <code>headbang</code> || Perform the concert headbang pose. || <code>hold</code> || <code>0.03 s</code> ||
|-
| <code>fistpump</code> || Perform the concert fist-pump pose. || <code>hold</code> || <code>0.03 s</code> ||
|-
| <code>pogo</code> || Perform the concert pogo pose. || <code>hold</code> || <code>0.03 s</code> ||
|-
| <code>stomp</code> || Perform the concert stomp pose. || <code>hold</code> || <code>0.03 s</code> ||
|-
| <code>sway</code> || Perform the concert sway pose. || <code>hold</code> || <code>0.03 s</code> ||
|-
| <code>work</code> || Perform a smithing work animation. || <code>hold</code> || <code>50.7667 s</code> || Compatibility alias used by the bundled GothicRP activities; the authored montage presents visible smithing and its prop.
|-
| <code>mine</code> || Perform the pickaxe mining animation. || <code>hold</code> || <code>1.97333 s</code> || Compatibility alias used by the bundled GothicRP mining activities.
|-
| <code>pickup</code> || Pick up an item from the ground with the left hand. || <code>once</code> || — || Compatibility alias used by the bundled GothicRP gathering activities; authored as a one-shot.
|}

== Usage ==
<syntaxhighlight lang="lua">
-- Hold a prayer pose using its catalogued loop point.
startAnim(playerId, "pray", true, 0.2)

-- Play a one-shot animation from the beginning.
startAnim(playerId, "puke", false, 0.15)

-- Stop only the tracked scripted animation.
stopAnim(playerId)
</syntaxhighlight>

== Return-value contract ==
For both [[startAnim]] and [[stopAnim]], <code>true</code> means the server accepted the request, updated or retransmitted authoritative state, and attempted reliable delivery. It is not a synchronous client-playback or transport acknowledgement. Requests rejected during server validation return <code>false</code>. Client loading and presentation retries are bounded; terminal misses are written to the animation diagnostic log instead of retrying forever.

== Related functions ==
* [[startAnim]]
* [[stopAnim]]

[[Category:Lua API]]
[[Category:Lua Catalogs]]
[[Category:Animation Functions]]

Player animation catalog - Revision history

QCherry: Add the player animation catalog for update 0.1.2