animations

Last updated on

Players play emotes with /e dance or the picker on F3 (built with the menu) and stop with X. Other modules use the contract to play an animation on the local player (a ripperdoc chair, drinking an item). The module plays nothing itself: solo emotes go to the platform's animation service, pairs to its two-player coordinator. It adds the picker, a per-player rate limit, a readiness check, the invitation and walking paces on the player's own eye menu. Nothing is written to the database.

Catalogue

Every profile the platform lists is offered: 104 on op77.123, read at start with Open77.animations.list, so a profile a later build adds shows up at the next start. Fifteen rows are also written in shared/catalogue.lua and win on the same name. The full list is on Catalogue.

Not offered: names in DISABLED, profiles whose validation word says they failed (fail, broken, unsupported…), malformed rows. The boot log has one line with the counts:

[animations] platform catalogue: 104 profiles listed, 89 adopted (not adopted: written 15)

The picker draws 12 families, 16 emotes to a page. The platform's own family words map onto them:

/e dance is the emote, not the family (hence music and sitting). A one-shot gesture (wave, shrug…) plays once for the clip length the platform measured; a layer profile (the _walk rows) keeps your own walking.

With a nearby player

Picker › With a nearby player, or /e with …. The server invites the nearest player within SHARED.RANGE, from positions it observes — no client names who is invited. Nothing plays until they accept.

/e with carry            invite the nearest player: you carry them
/e with dance            both dance
/e with preach armscrossed   you preach, they cross their arms
/e accept                the invited player says yes
/e decline               ... or no

• A paired move's id is read before a profile of the same word: /e with carry is the move, /e with carry carry is the carry profile on both.
• In the picker, Any two animations is two picks — yours, then theirs ("The same" on top) — so every ordered pair (104 × 104) is reachable without a 10 000-row list.
• The invited player gets a two-row menu (Accept, Decline) or a chat line naming /e accept and /e decline. No name either way: "The person next to you invites you: {emote}.", and the asker reads sent, accepted or declined without the other's name.

ask ─► nearest player in RANGE invited ─► accept ─► distance measured again ─► pair starts
                                        ├► decline ─► asker told "declined" (no name)
                                        └► INVITE_MS passes ─► withdrawn, asker told "expired"

• An invitation counts against the same RATE_LIMIT window as a play.
• One invitation or pair per player, either side (duo_busy).
• The stop key, /opx.anim.stop or disconnecting ends the pair for both; the asker leaving withdraws the invitation.
• The coordinator also ends a pair on death, a vehicle, a bucket change, separation (RANGE + 2 m, at most 20) or a failed presentation; both players are told why.

What the platform cannot do

• A custom pair is stationary: either body walking off ends it, a walking layer included. Only carry and escort move, and those two take no profile override (paired_animation_fixed).
• A pair plays a profile, not a clip: no variant choice.
• Two players per interaction, one interaction each.
• Solo emotes are refused by the service for a dead player or one in a vehicle (player_not_alive, player_in_vehicle).

Commands

All four act on the caller only and are open by default.

Names come from COMMANDS; RESTRICTED = true gates command.<name>.

Configuration

config/animations.lua sets OPX.Config.MODULES.animations. Shared script.

SHARED = {
	ENABLED = true,
	RANGE = 3.0,         -- metres between the two bodies, 0.25..10
	INVITE_MS = 15000,   -- how long an invitation waits, 1000..60000
	KINDS = {            -- the platform's paired moves; DURATION_MS 500..600000
		carry  = { ENABLED = true, DURATION_MS = 60000 },
		escort = { ENABLED = true, DURATION_MS = 60000 },
		give   = { ENABLED = true, DURATION_MS = 5000 },
		heal   = { ENABLED = true, DURATION_MS = 12000 },
	},
	ANY = true,          -- any two profiles, one per body
	DURATION_MS = 30000, -- length of such a pair; two one-shot gestures use the longer clip
	PAIRS = {            -- shortcuts listed above "any two"
		{ ID = 'talk', ACTOR = 'preach', TARGET = 'armscrossed', DURATION_MS = 20000 },
		{ ID = 'film', ACTOR = 'record', TARGET = 'dance', DURATION_MS = 30000 },
	},
},

• KINDS.<kind>.ENABLED = false withholds both sides of that move. Only carry, escort, give, heal are kinds; another key is a boot warning.
• A PAIRS row: ID unique, lower case, not a move's id; its label is the locale key animations.duo.name.<ID> (without one the row reads its two profiles). A row naming a profile the build lacks or one in DISABLED is not offered.
• A bad value is a boot warning and falls back to the default shown.
• Pairs need open77_player_interactions running; without it the boot log says so and the picker has no With a nearby player row.

Refusal codes

A refusal caused by a contract call is not shown to the player (the caller decides); refusals from keys, commands and the picker are shown.