Verse API reference page for the grind_powerup_device class
Used to let agents slide on any surface with accompanying visual and audio effects.
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. |
powerup_device |
Base class for various powerup devices offering common events like ItemPickedUpEvent. |
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 |
|---|---|
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. |
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. |
Pickup |
Grants this powerup to Agent. |
Pickup |
Grants this powerup without an agent reference. Requires Apply To set to All Players. |
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. |
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. |