Skip to content
Version 2.32.0
↓ Get the launcher

IPosing interface

Pose people in the world, like the game’s own photo panel — with or without a free camera (ICameraOverride): the local player live, other players as a local photo copy (the real player hidden), NPCs as a locally generated model (the real NPC hidden and never changed). Everything is local: copies and generated models send nothing. The copy or model is made on the first control that changes something, never on Select. Poses belong to the scene, not the camera: leaving the free camera keeps every pose. The scene ends — and the framework resets every touched person (action, expression, look, facing; copies and models removed, real people shown again) — on the reasons the scene freeze ends on: a zone change or scene leave, a cutscene, the game’s own camera mode, a disconnect and the framework unloading; also on ResetAll. A person who leaves is released alone; a plugin’s people are released when it unloads. At most the game’s own photo-member limit of copies (you plus limit − 1 players) and of NPC models exist at once; beyond it a target reports Full. While the scene freeze (ISceneFreeze) is on, posed copies and models freeze too. Main thread only.

public interface IPosing
name description
Expressions { get; } The game’s facial expressions, in the game’s order. Empty until the player is in the world.
IsAvailable { get; } True while the player is in the world and the scene has settled (false for about 2 s after a zone change while the game rebuilds every entity) — the only time people can be posed. Independent of the free camera.
event Changed Raised (main thread) when a target’s State changed: a model finished loading or failed, a person was reset or released.
NearbyPeople(…) The people within radius m of the local player: the local player first, then players and NPCs by distance. Reads the game once per call (allocates) — call it on a user action, not every frame. Empty while IsAvailable is false.
ResetAll() Resets every person this plugin touched, now (the free camera, if any, stays on).
Select(…) The pose target for person (the same object while it lives), or null when posing is not available, the entity is not a player or an NPC, or another plugin is posing that person.
TryGetCurrentAction(…) The action (emote / pose) person is doing right now, as the game reports it — the one they were already doing when selected, or the one held or played on them through IPoseTarget. Read from their posed copy or stand-in when one exists (held or not), else from the person themselves; local only (nothing is sent). False while posing is not available, when the person is idle, gone or unreadable, and for ~2 s after a scene change. Compiled reads, no reflection lookup per call: cheap enough for a panel that polls a few times a second. Reading a person who has no posed copy allocates only the game interop’s two small per-call object wrappers (entity and model lookup).
TryGetVisiblePosition(…) Where the visible copy or stand-in of person stands — what a camera orbiting them should centre on while the real person is hidden (and may walk away). False for the local player (posed live), for a person not posed yet or still loading, and once released. No allocation: safe to call every frame.