Used to spawn customizable boxes containing vehicle mods. Hit a box with a vehicle to apply the mod.
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. |
Exposed Interfaces
This class exposes the following interfaces:
Name | Description |
---|---|
enableable |
Implemented by classes whose instances can be enabled and disabled. |
Members
This class has both data members and functions.
Data
Data Member Name | Type | Description |
---|---|---|
BoxDestroyedEvent |
listenable(payload) |
Triggers whenever the mod box is destroyed regardless of whether a mod was applied. Returns tuple:
|
BoxSpawnedEvent |
listenable(payload) |
Triggers whenever the mod box spawns.
|
ModAppliedEvent |
listenable(payload) |
Triggers whenever the mod is applied to a vehicle. Returns tuple:
|
ModApplyFailedEvent |
listenable(payload) |
Triggers whenever the mod fails to apply to a vehicle. Returns tuple:
|
ModApplyOverriddenEvent |
listenable(payload) |
If ModAppliedEvent is overridden (see
|
ModBoxCustomListSettings |
?[]vehicle_mod_box_settings |
An array containing the custom settings for each entry in the device's custom list.
|
ModBoxOverallSettings |
?vehicle_mod_box_settings |
Contains the custom settings for Overall Visual Style, which can be individually set and returned. |
NoModEvent |
listenable(payload) |
Triggers whenever a
|
Functions
Function Name | Description |
---|---|
CycleToNextValidIndex |
If the mod box is spawned, respawn it as the next valid entry in the list without triggering
|
CycleToPreviousValidIndex |
If the mod box is spawned, respawn it as the previous valid entry in the list without triggering
|
DespawnBox |
Despawn the box and clear the spawn timer without triggering |
Disable |
Disable the device and clear any active spawn timer. While disabled, it will be hidden and vehicle mod boxes will not spawn. |
Enable |
Enable the device and start the spawn timer. While enabled, it can spawn vehicle mod boxes, and those boxes can be interacted with. |
GetActiveTimerRemaining |
Returns the remaining time (in seconds) of the device's active spawn timer.
|
GetCurrentIndex |
Returns the current index
|
GetInitialSpawnTimerLength |
Returns the total length of the initial spawn timer in seconds, regardless of the timer's current state. |
GetRespawnTimerLength |
Returns the total length of the respawn timer in seconds, regardless of the timer's current state. |
GetSpawnCount |
Returns the number of times the device has spawned a mod box. |
GetTransform |
Returns the transform of the |
IsEnabled |
Succeeds if the object is enabled, fails if it's disabled. |
IsSpawned |
Check if this device currently has a spawned mod box. |
IsValidIndex |
Succeeds if |
MoveTo |
Moves the |
MoveTo |
Moves the |
ResetModBoxName |
Reset the names of this device's mod boxes, if the name has been customized. |
ResetPlayerTooltip |
Reset the text of the tooltip that appears when a player gets close to the mod box without a vehicle, if it's been customized. |
SetCustomModBoxName |
Set this device's mod boxes to use the name
|
SetCustomPlayerTooltipText |
Set the
|
SetInitialSpawnTimer |
Set the remaining time (in seconds) on the initial spawn timer (clamped to a minimum of
|
SetNextModIndex |
Set the next mod box to spawn to be the one at
|
SetOverrideModApplyEvent |
If
|
SetRespawnTimer |
Set the remaining time (in seconds) on the respawn timer (clamped to a minimum of
|
SpawnBox |
Spawn a mod box if the device is enabled. If one is already spawned, spawn a new one without triggering |
SpawnLastChosenMod |
Spawn the same mod box this device spawned before the current one. If a mod box is already spawned, despawn that first without triggering
|
SpawnModBoxByIndex |
Spawn the mod box at
|
StartSpawnTimer |
Despawn the box if necessary without triggering |
TeleportTo |
Teleports the |
TeleportTo |
Teleports the |
TryApplyModByAgent |
Apply the mod at
|
TryApplyModByVehicle |
Apply the mod at
|