Verse API reference page for the player_checkpoint_device class
Used to set an agent's spawn point when activated. This can also clear the agent's inventory.
Verse using statement |
using { /Fortnite.com/Devices } |
Inheritance Hierarchy
This class is derived from the following hierarchy, starting with creative_object:
| Name | Description |
|---|---|
creative_object |
Base class for creative devices and props. |
creative_device_base |
Base class for creative_device. |
Members
This class has both data members and functions.
Data
| Data Member Name | Type | Description |
|---|---|---|
FirstActivationEvent |
listenable(payload) |
Signaled when this device is first activated by any agent. Sends the agent that activated this device. |
FirstActivationPerAgentEvent |
listenable(payload) |
Signaled each time a new agent activates this device. Sends the agent that activated this device. |
Functions
| Function Name | Description |
|---|---|
Disable |
Disables this device. |
Enable |
Enables this device. |
GetGlobalTransform |
Gets the global transform of this object. |
GetRegisteredAgents |
Returns an array of agents that are currently registered to this checkpoint. |
GetTransform |
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. |
IsRegistered |
Succeeds when Agent is registered to this checkpoint. |
MoveTo |
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. |
MoveTo |
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. |
MoveTo |
Moves the creative_device to the specified Transform over the specified time, in seconds. If an animation is currently playing on the creative_device it will be stopped and put into the AnimationNotSet state. |
Register |
Registers this checkpoint for Agent. This sets the respawn point and can clear Agent's inventory depending on this device's settings. Multiple agents can be registered to this device at one time. |
SetGlobalTransform |
Sets the global transform of this object. |
TeleportTo |
Teleports the creative_object to the specified Position and Rotation. |
TeleportTo |
Teleports the creative_object to the specified location defined by Transform, also applies rotation and scale accordingly. |
TeleportTo |
Teleports the creative_device to the specified location defined by Transform, also applies rotation and scale accordingly. |