Verse API reference page for the round_settings_device class
Used to customize gameplay for any round-based game. It generally defines what happens to theagent's inventory and rewards in each round.
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 |
|---|---|---|
RoundBeginEvent |
listenable(payload) |
Signaled when a game round starts. |
Functions
| Function Name | Description |
|---|---|
Disable |
Disables this device. |
DisableEndRoundConditions |
Disables all end-round conditions. The round must be ended through calling EndRound or a creative event after this is called. |
DisableMatchmaking |
Disables the ability for players to Matchmake into the Island. Only applies to published games that have matchmaking turned on in the Island settings |
Enable |
Enables this device. |
EnableMatchmaking |
Enables the ability for players to Matchmake into the Island. Only applies to published games that have matchmaking turned on in the Island settings |
EndRound |
Ends the round immediately with Agent's team set as the winner of the round. |
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. |
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. |
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. |
ToggleMatchmaking |
Toggles between EnableMatchmaking and DisableMatchmaking. |