Verse API reference page for the wildlife_spawner_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 customize the properties of NPCs spawned by this device. Changing properties will only affect newly spawned wildlife creatures.


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
`CanRide`	`?logic`	If true, agents can ride the wildlife creature.
`CanTame`	`?logic`	If true and the wildlife creature supports being tamed, agents can tame the NPC.
`Damage`	`??float`	If a value is given, the `Damage` value of the wildlife creature is overridden. If an override is not specified, the default `Damage` of the wildlife creature is used. This value is clamped between 1.0 and 500.0.
`DamagedEvent`	`listenable(payload)`	Signaled when wildlife is damaged. `Source` is the `agent` that damaged the wildlife. If the wildlife was damaged by a non-agent then `false` is returned. `Target` is the wildlife that was damaged.
`DamageToEnvironment`	`??float`	If a value is given, the `Damage` value of the wildlife creature is overridden when damaging the environment. If an override is not specified, the default `Damage` of the wildlife creature is used. This value is clamped between 1.0 and 500.0.
`DamageToPlayer`	`??float`	If a value is given, the `Damage` value of the wildlife creature is overridden when damaging players. If an override is not specified, the default `Damage` of the wildlife creature is used. This value is clamped between 1.0 and 500.0.
`DismountedEvent`	`listenable(payload)`	Signaled when an `agent` dismounts wildlife. `Source` is the `agent` that dismounted the wildlife. `Target` is the wildlife that was dismounted.
`EliminatedEvent`	`listenable(payload)`	Signaled when wildlife is eliminated. `Source` is the `agent` that eliminated the wildlife. If the wildlife was eliminated by a non-agent, or because the oldest wildlife was eliminated as Spawn function was called after spawn count was exceeded, then `Source` is 'false'. `Target` is the wildlife that was eliminated.
`EliminatingEvent`	`listenable(payload)`	Signaled when a wildlife eliminates an agent. `Source` is the wildlife that eliminated the agent. `Target` is the agent that was eliminated.
`EnergyConsumptionAmount`	`?int`	The amount of riding energy that is consumed when the `ConsumeEnergy` function is called. This value is clamped between 0 and 100.
`EnergyRestorationAmount`	`?int`	The amount of riding energy that is restored when the `RestoreEnergy` function is called. This value is clamped between 0 and 100.
`ForceSpawnedEvent`	`listenable(payload)`	Signaled when wildlife is force-spawned and causes the oldest wildlife to be eliminated. Sends the `agent` wildlife that was spawned.
`InitialEnergy`	`?int`	The amount of riding energy the wildlife creature spawns with. This value is clamped between 0 and 100.
`Invincible`	`?logic`	Whether the NPC can receive damage.
`MaxEnergy`	`?int`	The maximum riding energy the wildlife creature spawns with. This value is clamped between 0 and 100.
`MaxHealth`	`??float`	If a value is given, the `MaxHealth` value of the wildlife creature is overridden. If an override is not specified, the default Health of the wildlife creature is used. This value is clamped between 1.0 and 10000.0.
`PreventDismount`	`?logic`	If true, agents cannot manually use the interact action to dismount from the wildlife creature.
`RiddenEvent`	`listenable(payload)`	Signaled when an `agent` rides wildlife. `Source` is the `agent` that started riding the wildlife. `Target` is the wildlife that was ridden.
`SomethingIsEatenEvent`	`listenable(payload)`	Signaled when wildlife eats a pickup such as a Shroom or Meat. Sends the wildlife that ate something.
`SpawnedEvent`	`listenable(payload)`	Signaled when this device spawns wildlife. Sends the `agent` wildlife that was spawned.
`SpeedMultiplier`	`?float`	If a value is given, the `SpeedMultiplier` value is applied to the default speed of the wildlife creature. If an override is not specified, the wildlife creature moves at its default speed. This value is clamped between 0.1 and 2.0.
`TamedEvent`	`listenable(payload)`	Signaled when wildlife is tamed. `Source` is the `agent` that tamed the wildlife. `Target` is the wildlife that was tamed.
`TamedFollowDistance`	`??float`	Distance in meters from the player who tamed it that the wildlife creature will try to stay within. If a value is given, the `TamedFollowDistance` value of the wildlife creature is overridden. If an override is not specified, the default `TamedFollowDistance` of the wildlife creature is used. This value is clamped between 2.0 and 30.0.
`UntamedEvent`	`listenable(payload)`	Signaled when wildlife is untamed. `Source` is the `agent` that tamed the wildlife. `Target` is the wildlife that was untamed.
`WanderRange`	`??float`	Distance in meters from its spawn position from which the wildlife creature will peacefully roam. If a value is given, the `WanderRange` value of the wildlife creature is overridden. If an override is not specified, the default `WanderRange` of the wildlife creature is used. This value is clamped between 10.0 and 100.0.

Functions

Function Name	Description
`ConsumeEnergy`	Consumes energy from wildlife belonging to `Agent` by Energy Consume Amount.
`ConsumeEnergyForAll`	Consumes energy from wildlife by Energy Consume Amount.
`Despawn`	Despawns wildlife. `Agent` is marked as the one who eliminated the wildlife.
`DestroySpawner`	Destroys this device, marking `Agent` as the destroyer of the device.
`Disable`	Disables this device.
`Dismount`	Dismounts `Agent` from wildlife.
`DismountAll`	Dismounts all `agent`s from wildlife.
`Enable`	Enables this device.
`GetAgents`	Get all agents created by this device.
`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.
`Reset`	Resets the count on the Total Spawn Count option.
`RestoreEnergy`	Restores energy to wildlife belonging to `Agent` by Energy Restore Amount.
`RestoreEnergyForAll`	Restores energy to wildlife by Energy Restore Amount.
`Ride`	Teleports `Agent` to the nearest wildlife, then `Agent` mounts that wildlife.
`Spawn`	Spawns wildlife from this device. If spawn count is exceeded the oldest wildlife will be eliminated.
`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`` because it takes time to load the NPC before it can be returned.
`Tame`	Tames wildlife, making them AI partners of `Agent`.
`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.
`Untame`	Untames any tamed wildlife that belong to `Agent`.
`UntameAll`	Untames all wildlife.