Vehicle Mod Box Spawner

All Settings[]

Contextual Filtering[]

This device is affected by Contextual Filtering; This feature hides or displays options depending on the values selected for certain related options.

All default values have been Bolded.

All Options

Option	Value	Description
Enabled on Game Start	Yes, No	Determines whether the device starts the game enabled. While disabled the device and any box it has spawned will be hidden.
Visual Style	Default, Blank	Determines what a spawned mod box looks like. Blank - The mod box will look like an unpainted wooden crate.
Possible Mods	All, Tire Only, Bumper Only, Rooftop Only, Repair Box Only, Custom List	All - Choose randomly from among all possibilities. Repair Box Only - Only spawn the repair box. Custom List - Choose from among entries in a customized list.
Initial Mod	Random, Custom List Mod 1	Determines which mod box the device spawns first. Random - Choose randomly from among possible mods.
Change Mod on Respawn	Yes, No	Determines whether the mod box will select again from within the group set for Possible Mods when it respawns.
Respawn Selection	Random, Cycle	Determines how to choose a mod box when respawning. Random - Choose randomly from among possible mods. Cycle - From the initial mod onward, select each provided mod in order, and start over reaching the last entry,
Custom List Mod 1	Bulletproof Tires, Offroad Tires, Cow Catcher, Spiked Bumper, Grenade Launcher, Machine Gun, Repair	A mod that can be spawned by this device.
Custom List Mod 2	Empty Slot, Bulletproof Tires, Offroad Tires, Cow Catcher, Spiked Bumper, Grenade Launcher, Machine Gun, Repair	A mod that can be spawned by this device.
Custom List Mod 3	Empty Slot, Bulletproof Tires, Offroad Tires, Cow Catcher, Spiked Bumper, Grenade Launcher, Machine Gun, Repair	A mod that can be spawned by this device.
Custom List Mod 4	Empty Slot, Bulletproof Tires, Offroad Tires, Cow Catcher, Spiked Bumper, Grenade Launcher, Machine Gun, Repair	A mod that can be spawned by this device.
Custom List Mod 5	Empty Slot, Bulletproof Tires, Offroad Tires, Cow Catcher, Spiked Bumper, Grenade Launcher, Machine Gun, Repair	A mod that can be spawned by this device.
Custom List Mod 6	Empty Slot, Bulletproof Tires, Offroad Tires, Cow Catcher, Spiked Bumper, Grenade Launcher, Machine Gun, Repair	A mod that can be spawned by this device.
Initial Spawn Timer	0s - 300s	Determines the time in seconds before the mod box spawns for the first time. The timer gets cleared if it's active when the device is disabled.
Initial Spawn Timer	30s, 0s - 300s	Determines the time in seconds before the mod box respawns. The timer gets cleared if it's active when the device is disabled.
Avoid Duplicates	Yes, No	Determines whether a randomly-selected mod is allowed to be the same as the one that spawned last.
Avoid Duplicates	0 - 10	The higher the number, the more likely Custom List Mod 1 will be randomly chosen to spawn. 0 means it won't be randomly chosen.
Mod Box Name Style	Default, Custom, Hide	Control the spawned mod box's name and whether to display it. Custom - Set a custom name that all of the device's mod boxes will use.
Custom Mod Box Name	Default, Custom, Hide	Set a custom name that all of this device's mod boxes will use.
Show Player Tooltip	Yes, No	Determines whether to show the tooltip when a player gets close to the mod box without a vehicle.

Functions and Events[]

Functions

Option	Description
Enable When Receiving From	Enables the device and start the spawn timer. While the device is enabled, it can spawn vehicle mod boxes, and those boxes can be interacted with.
Disable When Receiving From	Disables the device and clears any active spawn timer. While disabled, it will be hidden and vehicle mod boxes will not spawn.
Spawn Box When Receiving From	Spawn a mod box. If a mod box is already spawned, despawn that first without triggering On Box Destroyed. The device must be enabled.
Despawn Box When Receiving From	Despawn the box and clear the spawn timer. The respawn hologram will be visible, but will not progress without Start Spawn Timer. Does not trigger On Box Destroyed. The device must be enabled.
Start Spawn Timer When Receiving From	Despawn the box if necessary without triggering On Box Destroyed, then start the spawn timer. The device must be enabled.
Spawn Last Chosen Mod When Receiving From	Spawn the same mod box this device spawned before the current one. If a mod box is already spawned, despawn that first without triggering On Box Destroyed. If this device is disabled or has not spawned more than one mod box, this does nothing.
Cycle to Previous Valid Index When Receiving From	If the mod box is spawned, respawn it as the previous valid entry in the list without triggering On Box Destroyed. If it is not spawned, that will be the next mod box. Does nothing if Possible Mods is not set to CUSTOM LIST or the device is disabled.
Cycle to Next Valid Index When Receiving From	If the mod box is spawned, respawn it as the next valid entry in the list without triggering On Box Destroyed. If it is not spawned, that will be the next mod box. Does nothing if Possible Mods is not set to CUSTOM LIST or the device is disabled.

Events

Option	Description
On Box Spawn Send Event To	Fires when the mod box spawns.
On Box Destroy Send Event To	Fires when the mod box is destroyed, regardless of whether a mod was applied, sending the instigator if applicable.
On Mod Applied Send Event To	Fires when the mod is applied to a vehicle, sending the driver of the vehicle as the instigator if applicable.
On Mod Failed to Apply Send Event To	Fires when the mod fails to apply to a vehicle, sending the driver of the vehicle as the instigator if applicable.

vehicle_mod_box_spawner_device class[]

using { /Fortnite.com/Devices }

Inheritance Hierarchy

Inheriting	Description
creative_object	Base class for creative devices and props.
creative_device_base	Base class for creative_device.

Data

Event Function	Type
BoxSpawnedEvent	listenable(int)
BoxDestroyedEvent	listenable(tuple(?agent, int))
ModAppliedEvent	listenable(tuple(?agent, fort_vehicle, int))
ModApplyFailedEvent	listenable(tuple(?agent, fort_vehicle, int))
ModApplyOverriddenEvent	listenable(tuple(?agent, fort_vehicle, int))

Functions

Function	Parameters	Description
Enable		Enable the device and start the spawn timer. While enabled, it can spawn vehicle mod boxes, and those boxes can be interacted with.
Disable		Disable the device and clear any active spawn timer. While disabled, it will be hidden and vehicle mod boxes will not spawn.
SpawnBox		Spawn a mod box if the device is enabled. If one is already spawned, spawn a new one without triggering BoxDestroyEvent.
DespawnBox		Despawn the box and clear the spawn timer without triggering BoxDestroyEvent. The respawn hologram will be visible, but will not progress without StartSpawnTimer. The device must be enabled.
IsSpawned		Check if this device currently has a spawned mod box.
GetSpawnCount		Returns the number of times the device has spawned a mod box.
StartSpawnTimer		Despawn the box if necessary without triggering BoxDestroyEvent, then start the spawn timer. The device must be enabled.
GetInitialSpawnTimerLength		Returns the total length of the initial spawn timer in seconds, regardless of the timer's current state.
SetInitialSpawnTimer		Set the remaining time (in seconds) on the initial spawn timer (clamped to a minimum of 0.0). The device must be enabled. Even if the initial spawn timer is not currently active, this sets its length.
SetInitialSpawnTimer	Time:float	Set the remaining time (in seconds) on the initial spawn timer (clamped to a minimum of 0.0). The device must be enabled. Even if the initial spawn timer is not currently active, this sets its length.
GetRespawnTimerLength		Returns the total length of the respawn timer in seconds, regardless of the timer's current state.
SetRespawnTimer	Time:float	Set the remaining time (in seconds) on the respawn timer (clamped to a minimum of 0.0). This also sets the length of this device's future respawn timers.
GetActiveTimerRemaining		Returns the remaining time (in seconds) of the device's active spawn timer. If there is no active timer, return 0.0.
GetCurrentIndex		Returns the current index int in the device's list of mod boxes. This value is set whenever the device spawns a new mod box. The device's list starts with 0 for Custom List Mod 1. If Possible Mods is not set to Custom List or the device has never spawned a mod box, int will be -1.
IsValidIndex	Index:int	Succeeds if Index is a valid entry in the device's list. Fails if Index is an invalid entry or Possible Mods is not set to Custom List.
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 BoxDestroyEvent. Does nothing if this device is disabled or has not spawned more than one mod box.
CycleToPreviousValidIndex		If the mod box is spawned, respawn it as the previous valid entry in the list without triggering BoxDestroyEvent. If the mod box is not spawned, that will be the next mod box. The list wraps, which means the last index is considered directly before the first index. Does nothing if this device is disabled or Possible Mods is not set to Custom List.
CycleToNextValidIndex		If the mod box is spawned, respawn it as the next valid entry in the list without triggering BoxDestroyEvent. If the mod box is not spawned, that will be the next mod box. The list wraps, which means the first index is considered directly after the last index. Does nothing if this device is disabled or Possible Mods is not set to Custom List.
SetNextModIndex	Index:int	Set the next mod box to spawn to be the one at Index in the device's list. The first index in the list is 0 for Custom List Mod 1. Does nothing if this device is disabled or Possible Mods is not set to Custom List.
SpawnModBoxByIndex	Index:int	Spawn the mod box at Index in the device's list. If a mod box is already spawned, despawn that first without triggering BoxDestroyEvent. The first index in the list is 0 for Custom List Mod 1. Does nothing if this device is disabled or Possible Mods is not set to Custom List.
TryApplyModByAgent	Index:int,Agent:agent	Apply the mod at Index in the device's list to the vehicle that Agent is riding. The first index in the list is 0 for Custom List Mod 1. Triggers ModApplyEvent and ModApplyFailEvent as appropriate, regardless of SetOverrideModApplyEvent. Fails if this device is disabled, Possible Mods is not set to Custom List, Index or Agent is invalid, or Agent is not riding a vehicle.
TryApplyModByVehicle	Index:int,Vehicle:fort_vehicle	Apply the mod at Agent in the device's list to Vehicle. The first index in the list is 0 for Custom List Mod 1. Triggers ModApplyEvent and ModApplyFailEvent as appropriate, regardless of SetOverrideModApplyEvent. Fails if this device is disabled, Possible Mods is not set to Custom List, Index or Vehicle is invalid. Vehicle must be an actual fort_vehicle. A vehicle spawner device will not be valid. ModApplyOverriddenEvent, ModApplyEvent, and ModApplyFailEvent are a few ways to get a fort_vehicle value.
SetOverrideModApplyEvent	Override:logic	If Override is true, destroying the mod box with a vehicle will trigger ModApplyOverriddenEvent and a mod will not be applied. In this case, destroying the mod box will not trigger ModApplyEvent or ModApplyFailEvent. The values returned by ModApplyOverriddenEvent can be used for TryApplyModByAgent and TryApplyModByVehicle, so the event can be handled manually.
SetCustomModBoxName	Name:message	Set this device's mod boxes to use the name Name. The displayed name will not exceed 50 characters. The following characters are disallowed: {, }, <, >, \, /, and |.
ResetModBoxName		Reset the names of this device's mod boxes, if the name has been customized.
SetCustomPlayerTooltipText	Name:message	Set the Text of the tooltip that appears when a player gets close to the mod box without a vehicle. The displayed text will not exceed 50 characters. The following characters are disallowed: {, }, <, >, \, /, and |.
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.