Table of Contents

Class SpawnerTaskScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from SpawnerTask.psc.

SpawnerTask allows to spawn and position an arbitrary number references in game world. It's effectively a batch combination of PlaceAtMe and SetPosition/MoveTo that smoothly executes in a single frame.

public static class SpawnerTaskScript
Inheritance
SpawnerTaskScript
Inherited Members

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

AddSpawn(int, IForm, IObjectReference, IReadOnlyCollection<float>, IReadOnlyCollection<float>, int, bool, bool)

public static Task AddSpawn(int handle, IForm formToPlace, IObjectReference target, IReadOnlyCollection<float> positionOffset, IReadOnlyCollection<float> rotation, int count = 1, bool bForcePersist = false, bool bInitiallyDisabled = false)

Parameters

handle int
formToPlace IForm
target IObjectReference
positionOffset IReadOnlyCollection<float>
rotation IReadOnlyCollection<float>
count int
bForcePersist bool
bInitiallyDisabled bool

Returns

Task

Cancel(int)

public static Task Cancel(int handle)

Parameters

handle int

Returns

Task

Create()

public static Task<int> Create()

Returns

Task<int>

Run(int)

public static Task<ObjectReference[]> Run(int handle)

Parameters

handle int

Returns

Task<ObjectReference[]>