StaticControlledStaticControlledGets the character currently controlled by the player.
StaticShowStaticOnStaticOnStaticGetStaticGetStaticAddRegisters a callback that is invoked whenever a character is spawned.
StaticRemoveUnregisters a previously added character-spawn callback.
StaticSpawnStaticPlayPlays a one-shot sound identified by key at a world position.
Optional$mixerType: SoundMixerTypeStaticPlayOptional$volume: numberStaticPlayStaticPlayPlays a sound event at a world position using the supplied transform as the playback owner.
Optional$mixerType: SoundMixerTypeStaticStopStaticIsStaticPushPushes a background music event onto the active BGM stack.
Optional$priority: BgmPriorityStaticPopPops a background music event from the active BGM stack.
Optional$priority: BgmPriorityStaticPlayOptional$scale: numberStaticLogStaticGetGets all active EntityCharacter instances currently registered in the entity manager.
An array of active characters, or an empty array when none are available.
StaticGetGets all characters within the specified radius of a world-space position.
An array of characters found in range, or an empty array when none are found.
StaticGetGets the visible model GameObject for a character.
The model object, or null if the character is invalid.
StaticGetGets a named body rigidbody from a character rig.
The matching rigidbody, or null if the body cannot be resolved.
StaticAttachAttaches a new ConfigurableJoint to a character body and connects it to another rigidbody.
Optional$bodyName: stringThe created joint, or null if the attachment point cannot be resolved.
StaticCharacterDetermines whether a rigidbody belongs to the specified character rig.
true if the rigidbody is part of the character; otherwise, false.
StaticIsDetermines whether the character is currently carrying the specified rigidbody as an item.
true if the rigidbody is carried by the character; otherwise, false.
StaticIsDetermines whether the character is grounded.
true if the character is grounded; otherwise, false.
StaticSetSets whether the character is in a "hanging" state (externally held while airborne).
StaticGetGets the current velocity of a character.
The main rigidbody velocity, or Vector3.zero if unavailable.
StaticSetSets the character movement velocity.
StaticAddAdds velocity or force to a character's main rigidbody.
Optional$mode: anyStaticAddAdds force or velocity to the character motion driver so the whole character moves coherently.
Optional$mode: anyStaticTeleportTeleports a character to the specified position and rotation.
StaticGetGets the current state from the character state machine.
The active state, or null if no state machine is available.
StaticAddRegisters a callback that is invoked whenever the character state changes.
StaticRemoveUnregisters a previously added character state change callback.
StaticAddRegisters a callback that is invoked whenever the character AI action changes.
StaticRemoveUnregisters a previously added AI action change callback.
StaticGetGets the main rigidbody for an entity.
The primary rigidbody, or null if unavailable.
StaticGetGets all rigidbodies owned by an entity.
An array of rigidbodies, or an empty array if the entity is invalid.
StaticGetGets the connected entity group represented by the specified entity.
An array of connected entities, or an empty array if the entity is invalid.
StaticSetSets whether an entity is pinned in place.
StaticSetSets whether gravity is enabled for an entity.
StaticSetActivates or deactivates an entity.
StaticIsDetermines whether an entity is currently activated.
true if activated; otherwise, false.
StaticSetSets whether an entity is visible.
StaticTeleportTeleports an entity to a world transform.
StaticAddRegisters a callback invoked when a weapon trigger is pressed.
StaticRemoveUnregisters a previously added weapon trigger-pressed callback.
StaticAddRegisters a callback invoked when a weapon trigger is released.
StaticRemoveUnregisters a previously added weapon trigger-released callback.
StaticAddRegisters a callback invoked when a hold weapon fires.
StaticRemoveUnregisters a previously added hold-weapon fired callback.
StaticSetSimulates trigger state changes on a firable weapon.
StaticGetGets the weapon reload or readiness fraction.
The reload fraction in the range [0, 1], or 0 if the weapon is invalid.
StaticHasDetermines whether a weapon currently has ammunition.
true if the weapon has ammo; otherwise, false.
StaticGetGets the current ammunition count for a weapon.
The current ammo count, or 0 if the weapon is invalid.
StaticGetGets the ammunition capacity for a weapon.
The ammo capacity, or 0 if the weapon is invalid.
StaticGetGets the transform for a vehicle.
The vehicle transform, or null if unavailable.
StaticGetGets the center-of-mass transform for a vehicle.
The center-of-mass transform, or null if unavailable.
StaticGetGets the primary door-handle transform for a vehicle.
The door-handle transform, or null if unavailable.
StaticIsDetermines whether a vehicle is in an exploded or destroyed driving state.
true if the vehicle is exploded; otherwise, false.
StaticCanDetermines whether vehicle yaw should rotate with the controlled camera.
true if yaw rotation should be coupled; otherwise, false.
StaticSetEnables or disables the vehicle engine state.
StaticApplyApplies throttle input to a vehicle.
StaticApplyApplies brake input to a vehicle.
StaticApplyApplies steering input to a vehicle.
StaticTriggerTriggers the vehicle's ability action.
StaticIsDetermines whether the supplied vehicle is a proxy-backed vehicle that can be configured through ModAPI.
true if the vehicle is a VehicleProxy; otherwise, false.
StaticClearClears all callback bindings on a proxy-backed vehicle.
StaticSetBinds the exploded-state getter for a proxy-backed vehicle.
StaticSetBinds the yaw-rotation capability getter for a proxy-backed vehicle.
StaticSetBinds the engine-enabled handler for a proxy-backed vehicle.
StaticSetBinds the throttle handler for a proxy-backed vehicle.
StaticSetBinds the brake handler for a proxy-backed vehicle.
StaticSetBinds the steering handler for a proxy-backed vehicle.
StaticSetBinds the ability-pressed handler for a proxy-backed vehicle.
StaticDemolishDemolishes a spherical region of a voxel object and optionally applies fragment force.
Optional$force: numberOptional$explodeDirection: anyOptional$spreadAngle: numberOptional$maxFragments: numberOptional$hardnessCap: numberStaticClearClears voxels along a screen-space line within a specific voxel chunk.
StaticExplodeStaticModifyStaticProjectProjects a decal texture onto voxel colors and related voxel surface properties.
Optional$splatType: SplatTypeOptional$opacity: numberStaticGetGets the current solid voxel count for a voxel volume.
The number of currently solid voxels, or 0 if the volume is invalid.
StaticGetGets the original solid voxel count recorded for a voxel volume.
The original number of solid voxels, or 0 if the volume is invalid.
StaticGetGets the remaining solid voxel ratio for a voxel volume.
The current solid ratio, or 0 if the volume is invalid.
StaticAddRegisters a callback that is invoked whenever the voxel volume is modified.
StaticRemoveUnregisters a previously added voxel-modified callback.
StaticAddRegisters a callback that is invoked whenever the voxel object creates fragments.
StaticRemoveUnregisters a previously added voxel-fragmented callback.
StaticIsDetermines whether a voxel object is currently destructible.
true if the voxel object can currently be destroyed; otherwise, false.
StaticSetSets whether a voxel object is destructible.
StaticIsDetermines whether a voxel object is currently marked as unyielding.
true if the voxel object is unyielding; otherwise, false.
StaticSetEnables or disables the unyielding state for a voxel object.
StaticSetSets whether a voxel object is fortified.
StaticClearStaticClearClears voxels within a box-shaped sweep constrained to a specific chunk.
Optional$hardnessCap: numberStaticRestoreRestores voxel colors from their stored original color state.
StaticGetGets the voxel material identifier sampled at a world-space position.
The voxel data at the queried position.
StaticGetGets the voxel material identifier sampled at a local voxel-space position.
The voxel data at the queried position.
StaticGetGets the voxel material identifier for a physics raycast hit.
The voxel data at the hit point.
StaticGetGets the voxel face render target associated with a character head rig.
The face render target voxel volume, or null if none can be resolved.
StaticSetSets the face-rendering properties on a voxel face render target.
StaticIsProtected[___
Gets the vehicle currently controlled by the player.