carryable_spawner_device class

Base class for creative devices and props.

Base class for creative_device.

Implemented by classes whose instances can be enabled and disabled.

Signaled when the carryable collides with an agent. Damage applied is based off the collision velocity, as well as the device's Impact Damage settings. This event will fire even if the damage applied is 0.

Maps to the device option for Takes Damage. Whether or not the carryable takes damage / can be destroyed.

The carryable transform, if the carryable exists in-world.

The agent carrying the carryable, if one exists.

Signaled when agent drops the carryable. Includes manual drop as well as force drop, which can occur on entering a state that doesn't support carrying, such as elimination.

Signaled when the carryable explodes. Returns the instigating agent, if one exists.

• The agent provided to the Explode function, or the agent who dealt lethal damage to the carryable.
• Otherwise, the agent who most recently carried the item. Returns an array of agents affected by the explosion.

Maps to the device option for Explosion Character Damage. Describes how much damage is done to characters caught in the carryable explosion.

Maps to the device option for Explosion Environmental Damage. Describes how much damage is done to world objects caught in the carryable explosion.

Maps to the device option for Explosion Impulse. Describes the strength of the knockback impulse applied by the carryable explosion.

Maps to the device option for Explosion Radius. Describes the radius (in meters) of the carryable explosion.

Maps to the device option for Impact Character Damage. Describes how much damage is done to characters hit by the carryable. This value is scaled by the impact magnitude to calculate the applied damage.

Maps to the device option for Impact Environmental Damage. Describes how much damage is done to world objects hit by the carryable. This value is scaled by the impact magnitude to calculate the applied damage.

Maps to the device option for Initial Spawn Angle. The angle (in degrees) of the cone from which the carryable will be randomly tossed when it first spawns.

Maps to the device option for Initial Spawn Velocity. The velocity (in meters per second) applied to the carryable when it first spawns.

Signaled when agent picks up the carryable.

Signaled when agent stops carrying the carryable. This includes dropping, throwing, despawning, or force pickup by another player.

Signaled when the carryable spawns, either by the Spawn function, or by timer.

Maps to the device option for Starting Health. Describes how much health the carryable spawns with.

Signaled when agent throws the carryable.

Despawn the carryable, if it exists.

Disables this device, preventing it from listening for inputs and sending events. When disabled, the carryable is unspawned, if it exists.

Enables this device, allowing it to listen for inputs and send events.

Explode the carryable, if it exists.

Explode the carryable, if it exists. Assigns the provided agent as the explosion instigator.

Forces the carryable to be carried by the provided player, teleporting it into their hands. If not in a viable state to carry the item (such as in a vehicle), or if the player fails the device's filters, it is ignored.

Returns the transform of the creative_object with units in cm. You must check creative_object.IsValid before calling this if there is a possibility the object has been disposed or destroyed by gameplay. Otherwise a runtime error will result.

Succeeds if the object is enabled, fails if it is disabled.

Fails if the carryable does not exist in-world.

Moves the creative_object to the specified Position and Rotation over the specified time, in seconds. If an animation is currently playing on the creative_object it will be stopped and put into the AnimationNotSet state.

Moves the creative_object to the specified Transform over the specified time, in seconds. If an animation is currently playing on the creative_object it will be stopped and put into the AnimationNotSet state.

Set the material of the carryable. Index describes which material index on the mesh the material will apply to. This will update immediately if already spawned, and also apply to any carryable spawned from this device in the future.

Set the mesh of the carryable. This will update immediately if already spawned, and also apply to any carryable spawned from this device in the future.

Spawn the carryable from the device if it doesn't currently exist.

Teleports the creative_object to the specified Position and Rotation.

Teleports the creative_object to the specified location defined by Transform, also applies rotation and scale accordingly.