Skip to main content

motion.play

Overview

  • Play a character animation on the target Zoi. anim_id: CharacterAnim row name (use motion.list to find). section: start section name (Default/Loop/End or motion-specific; default: Default). Use motion.get_info to see valid sections for a motion. position: start position in seconds within the section (default: 0.0). The animation interrupts the current motion. Use motion.stop to stop.

Metadata

FieldValue
DisplayPlay Motion
Categorymotion
AccessUserCheat
ScopeB2Authority
Tags
AliasesMotionPlay

Parameters

NameTypeRequiredDefaultDescription
anim_idnameyesAnimation ID to play (from motion.list)
entity_identityIdnoTarget entity ID (default: possessed)
sectionnamenoStart section (Default/Loop/End, default: Default)
positionfloatnoStart position within section in seconds (default: 0.0)

Returns

  • Return shape is not declared for this command.

Usage

await inzoi.cli.execute('motion.play', {
anim_id: '',
entity_id: 0, // optional
section: '', // optional
position: 0.0, // optional
});