Verse API reference page for the bank_vault_device class | Fortnite Documentation

This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.

A vault door that requires a start of a sequence to damage a number of weakpoints to open.


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
`bank_vault_interface`

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`ActivateWeakpointEvent`	`listenable(payload)`	Triggers when a weakpoint is activated. The weakpoint will begin to glow, but does not become vulnerable until a subsequent `WeakpointVulnerableEvent`. Sends the `agent` that activated the vault or none if the sequence was triggered by a function, and the `int` index of the weakpoint from 0-4, in order of activation.
`DestroyWeakpointEvent`	`listenable(payload)`	Triggers when a weakpoint is destroyed. Sends the last `agent` that damaged the weakpoint or the `agent` that started the sequence if no external damage was done or none if the sequence was triggered by a function, and the `int` index of the weakpoint from 0-4, in order of activation.
`MaxWeakpointHealth`	`?float`	The max health of this device's weakpoints.
`OpenEvent`	`listenable(payload)`	Triggers when the vault is opened either by the destruction of its weakpoints or by an event. Sends the last `agent` that damaged a weakpoint or the `agent` that started the sequence if no external damage was done or none if the sequence was triggered by a function.
`RequireThermite`	`?logic`	Whether the player needs thermite when interacting with the door to start the vault opening sequence.
`StartSequenceEvent`	`listenable(payload)`	Triggers when the vault sequence is started by a player or event. Sends the `agent` that triggered this event, if applicable.
`WeakpointDamagePerSecond`	`?float`	Damage dealt to the active weakpoint each second. Negative numbers heal the weakpoint. Weakpoints can only be damaged while the vault sequence is active.
`WeakpointTakesExternalDamage`	`?logic`	Whether the weakpoint takes damage from weapons and items while vault sequence is active.
`WeakpointVulnerableEvent`	`listenable(payload)`	Triggers when a weakpoint becomes vulnerable. Sends the `agent` that activated the vault or none if the sequence was triggered by a function, and the `int` index of the weakpoint from 0-4, in order of activation.

Functions

Function Name	Description
`DestroyActiveWeakpoint`	Destroy the active weakpoint. Requires the device to be enabled. Must have active weakpoint.
`Disable`	Disable the device. Pauses vault sequence.
`Enable`	Enable the device.
`ForceOpen`	Destroys the remaining weakpoints and opens the vault door. Requires the device to be enabled.
`GetActiveWeakpointHealth`	Get active weakpoint's health. If there is no active weakpoint, returns false.
`GetActiveWeakpointIndex`	Gets the active weakpoint's index starting at `0`, regardless of device's enabled state. Returns false if there is no active weakpoint, such as when the sequence is not active or directly after a weakpoint is destroyed.
`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.
`GetWeakpointCount`	Gets the total number of weakpoints.
`IsEnabled`	Succeeds if the device is enabled, fails if it's disabled.
`IsSequenceActive`	Whether the vault sequence is currently active and not paused.
`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.
`PauseSequence`	Disable the weakpoint vulnerability and freeze the progress of each one. Weakpoints can only be damaged while the vault sequence is active.
`Reset`	Restores vault to default state, deactivates the device, and heals all weakpoints to max health. Requires the device to be enabled.
`RestoreActiveWeakpoint`	Restores the active weakpoint to full health. Requires the device to be enabled. Must have active weakpoint.
`SetActiveWeakpointHealth`	Set active weakpoint's health. Setting it to `0.0` will destroy the weakpoint. Clamps to maximum of WeakpointMaxHealth.
`StartSequence`	Begin the sequence of events to open the vault door without thermite, or unpauses the sequence if it was paused. Requires the device to be enabled. Weakpoints can only be damaged while the vault sequence is active.
`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.