Verse API reference page for the pulse_trigger_device class
A device used to damage players who collide with it. Can also be used as a trigger to activate other devices.
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 functions, but no data members.
Functions
| Function Name | Description |
|---|---|
Begin |
Starts the damage pulse. |
Disable |
Disables this device. |
Enable |
Enables this device. |
End |
Stops the damage pulse. |
GetDamage |
Returns the damage to be applied to those hit by an active pulse. Clamped between 0 <= GetDamage <= 100000. |
GetLoopCount |
Returns the total number of times this pulse will complete before ending. 0 indicates the pulse will continue indefinitely. |
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. |
GetWaveSpeed |
Returns the speed (in meters per second) at which the pulses generated by this pulse trigger will travel. |
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. |
ResumePulse |
Resumes the damage pulse from the last position where it was stopped. |
ResumeSequence |
This function is deprecated. Use ResumePulse instead of this. Resumes the damage sequence from the last position where it was stopped. |
SetDamage |
Sets the damage to be applied to those hit by an active pulse. Clamped between 0 <= GetDamage <= 100000. Pulse visuals will change to reflect whether the pulse causes damage or not. |
SetLoopCount |
Sets the total number of times this pulse will complete before ending. LoopCount = 0 indicates the pulse should continue indefinitely. |
SetWaveSpeed |
Sets the speed (in meters per second) at which the pulses generated by this pulse trigger will travel. |
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. |