Verse API reference page for the volume_device class | Fortnite Documentation

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

Used to track when agents enter and exit a volume.


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.

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`AgentEntersEvent`	`listenable(payload)`	Signaled when an `agent` enters the device volume.
`AgentExitsEvent`	`listenable(payload)`	Signaled when an `agent` exits the device volume.
`PropEnterEvent`	`listenable(payload)`	Signaled when an `creative_prop` entered the device volume.
`PropExitEvent`	`listenable(payload)`	Signaled when an `creative_prop` exited the device volume.

Functions

Function Name	Description
`AddTag`	Adds a `tag` instance to this object. Returns a `tag_key` that is uniquely associated with the added instance.
`ContainsAllTags`	Fails if at least one type in `tag_types` cannot be found on this object, succeeds otherwise. Note that this means that if `tag_types` is empty this call succeeds.
`ContainsAnyTag`	Succeeds if at least one of the types in `tag_types` is found on this object, fails otherwise. Note that this means that if `tag_types` is empty this call fails.
`ContainsTag`	Succeeds if at least one tag of type `tag_type` is found on this object, fails otherwise.
`GetAgentsInVolume`	Returns an array of agents that are currently occupying the volume.
`GetGlobalTransform`	Gets the global transform of this object.
`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.
`IsInVolume`	Succeeds when `Agent` is in the volume.
`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.
`MoveTo`	Moves the `creative_device` to the specified `Transform` over the specified time, in seconds. If an animation is currently playing on the `creative_device` it will be stopped and put into the `AnimationNotSet` state.
`RemoveAllTags`	Removes all tag instances of type `tag_type`, succeeds if at least one instance was removed, fails otherwise.
`RemoveAllTagsExcept`	Removes all tag instances that are not of type `tag_type`, succeeds if at least one instance was removed, fails otherwise.
`RemoveAllTagsExcept`	Removes all tag instances that are not of any of the types in `tag_types`, succeeds if at least one instance was removed, fails otherwise.
`RemoveTag`	Removes the tag instance associated with the `tag_key`, succeeds if an instance was removed, fails otherwise.
`SetGlobalTransform`	Sets the global transform of this object.
`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.
`TeleportTo`	Teleports the `creative_device` to the specified location defined by `Transform`, also applies rotation and scale accordingly.