Verse API reference page for the hive_stash_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 strange organic object that may have something or someone inside of it.


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.
`healthful`	Implemented by Fortnite objects that have health state and can be eliminated.

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`CanBeDamaged`	`?logic`	Whether the hive stash can be damaged. `true` by default.
`CanDropItems`	`?logic`	Whether the hive stash drops items when opened. This can happen in addition to an `agent` being rescued. `true` by default.
`HiveStashStyle`	`?hive_stash_style`	Determines what players can see inside the hive stash, as well as its interaction text. This does not affect what happens when it opens. `Empty` shows nothing and says `Break Open`. `Loot` shows a chest and says `Break Open`. `Trapped` shows a floating character and says `Rescue`.
`InteractTextOverride`	`?message`	If set, this overrides the text shown when interacting while the hive stash is closed.
`OpenEvent`	`listenable(payload)`	Triggers whenever the hive stash is opened, returning the instigating `agent` if applicable.
`RescueAnimationEndEvent`	`listenable(payload)`	Triggers when the rescue animation ends. Returns the rescued `agent`.
`RescueEvent`	`listenable(payload)`	Triggers whenever an `agent` is rescued, either by the hive stash opening with a linked spawner, or by calling RescueAgent while the hive stash is closed. Returns the rescued `agent`.
`ShouldKeepLinkOnReset`	`?logic`	Whether to keep or clear a spawner link when Reset is called. Links can always be cleared with ClearSpawnerLink. `true` by default.
`ShouldPlayRescuedAnimation`	`?logic`	Whether an `agent` spawned from registered data or teleported by FreeAgent plays a short animation to get them off the hive stash. The animation may not work properly on skeletons other than the average player skeleton. `true` by default.

Functions

Function Name	Description
`ClearSpawnerLink`	Clear the link between the hive stash and a spawner device.
`Disable`	Disable the device, preventing players from interacting with it. Changes to health and state, such as those caused by damage, can still be applied.
`Enable`	Enable the device, allowing players to interact with it.
`GetHealth`	Get the device's current health.
`GetMaxHealth`	Get the device's current maximum health.
`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.
`HasLinkedSpawner`	Succeeds if the device currently has a linked spawner, fails otherwise.
`IsEnabled`	Succeeds if the device is enabled, fails if it's disabled.
`IsOpen`	Succeeds if the hive stash is currently open, fails otherwise.
`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.
`Open`	Open the hive stash. If a spawner is linked, trigger it and rescue the resulting `agent` from the hive stash. When the `agent` is rescued, if ShouldPlayRescuedAnimation is `true`, they will play a short animation to get off the hive stash.
`RescueAgent`	Teleport `Agent` to the hive stash. If ShouldPlayRescuedAnimation is `true`, they will play a short animation to get off the hive stash. If the hive stash is closed, it will burst open first, ignoring a linked spawner. This will not clear a linked spawner. Has no effect if `Agent` cannot be teleported for any reason, such as not being in the game anymore.
`Reset`	Reset the hive stash. This closes it, sets it to full health, and sets ShouldPlayRescuedAnimation, CanBeDamaged, CanDropItems, InteractTextOverride, and HiveStashStyle to their initial values. This can also clear the link to a spawner depending on ShouldKeepLinkOnReset. The hive stash will not reset if the rescue animation is currently playing.
`SetHealth`	Set the device's current health.
`SetLinkedSpawner`	Link the hive stash to `GuardSpawner`. This overrides the hive stash's existing link if one exists. If the hive stash opens with a linked spawner, trigger the spawner and rescue the resulting `agent` from the hive stash. The rescued `agent` respects its spawner's events, functions, spawn count, and spawn limits.
`SetLinkedSpawner`	Link the hive stash to `NPCSpawner`. This overrides the hive stash's existing link if one exists. If the hive stash opens with a linked spawner, trigger the spawner and rescue the resulting `agent` from the hive stash. The rescued `agent` respects its spawner's events, functions, spawn count, and spawn limits.
`SetLinkedSpawnerFromAgent`	If `Agent` was spawned by a `guard_spawner_device` or `npc_spawner_device`, link the hive stash to that spawner. This overrides the hive stash's existing link if one exists. Fails if `Agent` is not from a `guard_spawner_device` or `npc_spawner_device`, or if `Agent` was already eliminated. If the hive stash opens with a linked spawner, trigger the spawner and rescue the resulting `agent` from the hive stash. The rescued `agent` respects its spawner's events, functions, spawn count, and spawn limits.
`SetMaxHealth`	Set the device's current maximum health.
`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.