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

Used to create and manipulate volumes of water where players can swim, fish, or drive boats.


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
`AgentEntersWaterEvent`	`listenable(payload)`	Signaled when an `agent` enters the water. Sends `agent` that entered the water.
`AgentExitsWaterEvent`	`listenable(payload)`	Signaled when an `agent` exits the water. Sends `agent` that exited the water.
`VerticalEmptyingCompletedEvent`	`listenable(payload)`	Signals when the water volume is completely empty.
`VerticalFillingCompletedEvent`	`listenable(payload)`	Signals when the volume is filled to the water level set in the Default Vertical Water Percentage option.

Functions

Function Name	Description
`BeginVerticalEmptying`	Starts vertically emptying the water in the volume.
`BeginVerticalFilling`	Starts vertically filling the water in the volume.
`Disable`	Disables this device.
`Enable`	Enables this device.
`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.
`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.
`Reset`	Resets the water level in the volume to the value set in the Default Vertical Water Percentage option.
`ResumeVerticalMovement`	Resumes either filling or emptying the volume.
`StopVerticalMovement`	Stops filling or emptying the volume.
`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.

Can't find any content

Inheritance Hierarchy

Members

Data

Functions