Verse API reference page for the hive_stash_device class

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.

You're reading a preview

The full reference is free for BrainDeadGuild Discord members — sign in to read it all, or open the original at the source.