Verse API reference page for the bank_vault_interface interface | 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.


Verse `using` statement	`using { /Fortnite.com/Devices }`

Exposed Interfaces

This interface exposes the following interfaces:

Name	Description
`enableable`	Implemented by classes whose instances can be enabled and disabled.

Members

This interface has both data members and functions.

Data

Data Member Name	Type	Description
`StartSequenceEvent`	`listenable(payload)`	Triggers when the vault sequence is started by a player or event. Sends the `agent` that triggered this event, if applicable.
`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.
`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.
`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.
`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.
`RequireThermite`	`?logic`	Whether the player needs thermite when interacting with the door to start the vault opening sequence.
`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.
`MaxWeakpointHealth`	`?float`	The max health of this device's weakpoints.

Functions

Function Name	Description
`ForceOpen`	Destroys the remaining weakpoints and opens the vault door. Requires the device to be enabled.
`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.
`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.
`IsSequenceActive`	Whether the vault sequence is currently active and not paused.
`DestroyActiveWeakpoint`	Destroy the active weakpoint. Requires the device to be enabled. Must have active weakpoint.
`RestoreActiveWeakpoint`	Restores the active weakpoint to full health. Requires the device to be enabled. Must have active weakpoint.
`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.
`GetWeakpointCount`	Gets the total number of weakpoints.
`GetActiveWeakpointHealth`	Get active weakpoint's health. If there is no active weakpoint, returns false.
`SetActiveWeakpointHealth`	Set active weakpoint's health. Setting it to `0.0` or false will destroy the weakpoint. Clamps to maximum of WeakpointMaxHealth.