Verse API reference page for the capture_area_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 a zone that can trigger effects once players enter it. Can be set up to be capturable by a team, to provide a score while held, or to require a specific item as a drop-off.


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 this device area. Sends the `agent` that entered this device area.
`AgentExitsEvent`	`listenable(payload)`	Signaled when an `agent` exits this device area. Sends the `agent` that exited this device area.
`AreaIsContestedEvent`	`listenable(payload)`	Signaled when this device is contested. Sends the `agent` that is contesting this device.
`AreaIsScoredEvent`	`listenable(payload)`	Signaled when this device is scored. Sends the `agent` that scored this device.
`CaptureProgress`	`?float`	The current capture progress of the capture area. As a team captures the area, the value will increase from 0.0 to 1.0, with 1.0 representing a fully captured area. If the device supports neutralization or decay, the value will drop back towards 0.0 as it returns to neutral. If the device is disabled, the capture progress is set to 0.0.
`ControlChangeEvent`	`listenable(payload)`	Signaled when this device control changes. Sends the `agent` that triggered this device control change.
`ControlChangeStartsEvent`	`listenable(payload)`	Signaled when this device control change starts. Sends the `agent` that is triggering this device control change.
`FirstAgentEntersEvent`	`listenable(payload)`	Signaled when the first `agent` enters this device area. Sends the `agent` that entered this device area.
`ItemIsConsumedEvent`	`listenable(payload)`	Signaled when an item is consumed by this device. Sends the `agent` that provided the item to this device.
`ItemIsDeliveredEvent`	`listenable(payload)`	Signaled when an item is delivered to this device. Sends the `agent` that delivered the item to this device.
`LastAgentExitsEvent`	`listenable(payload)`	Signaled when the last `agent` exits this device area. Sends the `agent` that exited this device area.

Functions

Function Name	Description
`ActivateObjectivePulse`	Activates the objective pulse for this device.
`AllowCapture`	Allows this device to be captured.
`DeactivateObjectivePulse`	Deactivates the objective pulse for this device.
`Disable`	Disables this device.
`DisallowCapture`	Disallows this device from being captured.
`Enable`	Enables this device.
`GetAgentsInVolume`	Returns an array of agents that are currently occupying the Capture Area.
`GetHeight`	Returns the Capture Height (in meters) of the capture area.
`GetRadius`	Returns the Capture Radius (in meters) of the capture area.
`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.
`GiveControl`	Gives control of this device to the capturing `agent`'s team.
`IsInArea`	Is true when `Agent` is in the Capture Area.
`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.
`Neutralize`	Clears control of this device for all teams.
`Reset`	Resets control of this device for all teams.
`SetHeight`	Sets the Capture Height (in meters) of the capture area.
`SetRadius`	Sets the Capture Radius (in meters) of the capture area.
`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.
`ToggleCaptureAllowed`	Toggles between `AllowCapture` and `DisallowCapture`.
`ToggleEnabled`	Toggles between `Enable` and `Disable`.