Verse API reference page for the powerup_device class | Fortnite Documentation

Base class for various powerup devices offering common events like ItemPickedUpEvent.


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
`ItemPickedUpEvent`	`listenable(payload)`	Signaled when the powerup is picked up by an `agent`. Sends the `agent` that picked up the powerup.

Functions

Function Name	Description
`AddTag`	Adds a `tag` instance to this object. Returns a `tag_key` that is uniquely associated with the added instance.
`Clear`	Removes the powerup effect from `Agent`.
`ClearForAll`	Removes the powerup effect without an agent reference. Requires Apply To set to All Players.
`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.
`Despawn`	Despawns this powerup from the experience.
`GetDuration`	Returns the Duration that this powerup will be active for on any player it is applied to.
`GetGlobalTransform`	Gets the global transform of this object.
`GetRemainingTime`	If the `Agent` has the effect applied to them, this will return the remaining time the effect has. Returns -1.0 if the effect has an infinite duration. Returns 0.0 if the `Agent` does not have the effect applied.
`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.
`HasEffect`	Returns the `Agent` has the powerup's effect (or another of the same type) applied to them.
`IsSpawned`	Succeeds if the powerup is currently spawned.
`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.
`Pickup`	Grants this powerup to `Agent`.
`Pickup`	Grants this powerup without an agent reference. Requires Apply To set to All Players.
`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.
`SetDuration`	Updates the Duration for this powerup, clamped to the Min and Max defined in the device. Will not apply to any currently applied effects.
`SetGlobalTransform`	Sets the global transform of this object.
`Spawn`	Spawns the powerup into the experience so users can interact with it.
`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.