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.
|
CanDropItems |
?logic |
Whether the hive stash drops items when opened. This can happen in addition to an
|
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.
|
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 |
RescueAnimationEndEvent |
listenable(payload) |
Triggers when the rescue animation ends.
|
RescueEvent |
listenable(payload) |
Triggers whenever an
|
ShouldKeepLinkOnReset |
?logic |
Whether to keep or clear a spawner link when Reset is called. Links can always be cleared with ClearSpawnerLink.
|
ShouldPlayRescuedAnimation |
?logic |
Whether an
|
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 |
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 |
MoveTo |
Moves the |
Open |
Open the hive stash. If a spawner is linked, trigger it and rescue the resulting
|
RescueAgent |
Teleport
|
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.
|
SetHealth |
Set the device's current health. |
SetLinkedSpawner |
Link the hive stash to
|
SetLinkedSpawner |
Link the hive stash to
|
SetLinkedSpawnerFromAgent |
If
|
SetMaxHealth |
Set the device's current maximum health. |
TeleportTo |
Teleports the |
TeleportTo |
Teleports the |