Creature Spawner Device
Used to spawn one or more waves of creatures of customizable types at selected time intervals.
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 |
|---|---|---|
EliminatedEvent |
listenable(payload) |
Signaled when a creature is eliminated. Source is the agent that has eliminated the creature. If the creature was eliminated by a non-agent then Source is 'false'. Target is the creature that was eliminated. |
SpawnedEvent |
listenable(payload) |
Signaled when a creature is spawned. Sends the agent creature who was spawned. |
Functions
| Function Name | Description |
|---|---|
DestroySpawner |
Destroys this device. |
Disable |
Disables this device. |
EliminateCreatures |
Eliminates all creatures spawned by this device. |
Enable |
Enables this device. |
GetGlobalTransform |
Gets the global transform of this object. |
GetSpawnLimit |
Returns the spawn limit of the 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. |
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. |
SetGlobalTransform |
Sets the global transform of this object. |
SpawnAt |
Spawn a creature at the given position. When Rotation is not provided, it will default to the Device's rotation. Returns the agent spawned or false if the device has reached its maximum spawn count. This function is <suspends> because it takes time to load the creature before it can be returned. |
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. |