The SpawnerTask Script

Found in:

SKSE

The SpawnerTask script is a part of Skyrim SE’s Papyrus scripting ecosystem. This script is not present in the vanilla game, but can be found in modded sources like Skyrim Script Extender x64 (SKSE).

For this script, the Papyrus index knows about:

4 functions

Inheritance Tree

No indexed scripts extend this script.

Properties

No properties found.

Events

No events found.

Functions

- SKSE
intfunctionCreate()NativeGlobal
Creates a new SpawnerTask and returns a handle, which is an identifier for the created task.
The task handle is valid until the task has been run or canceled, or until the calling stack has exited.
(Function type: non-delayed)
- SKSE
voidfunctionAddSpawn(inthandle, FormformToPlace, ObjectReferencetarget, float[]positionOffset, float[]rotation, intcount=1, boolbForcePersist=false, boolbInitiallyDisabled=false)NativeGlobal
Adds a spawn to the task identified by the given handle.
Running the task places a new instance of formToPlace at target reference with given rotation and position offset. Parameters are analogously defined to PlaceAtMe.
Multiple spawns can be added to the same task to be executed in a batch (which is the purpose).
(Function type: non-delayed)
- SKSE
ObjectReference[]functionRun(inthandle)NativeGlobal
Runs the task and returns the spawned references in an array. May return arrays with a size larger than 128.
The resources allocated to the task are freed in the process, so the same task handle cannot be run twice.
(Function type: latent)
- SKSE
voidfunctionCancel(inthandle)NativeGlobal
Cancels a task before running it and frees its allocated resources.
Tasks cannot be canceled once they have been started with Run, and vice versa.