Class ModEventScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from ModEvent.psc.

ModEvent allows sending mod events with any number/type of arguments, unlike the more limited Form.SendModEvent.

public static class ModEventScript

Inheritance

object

ModEventScript

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

Create(string)

Creates a new ModEvent and returns the handle.

public static Task<int> Create(string eventName)

Parameters

eventName string

Returns

Task<int>

PushBool(int, bool)

public static Task PushBool(int handle, bool value)

Parameters

handle int

value bool

Returns

Task

PushFloat(int, float)

public static Task PushFloat(int handle, float value)

Parameters

handle int

value float

Returns

Task

PushForm(int, IForm)

public static Task PushForm(int handle, IForm value)

Parameters

handle int

value IForm

Returns

Task

PushInt(int, int)

public static Task PushInt(int handle, int value)

Parameters

handle int

value int

Returns

Task

PushString(int, string)

public static Task PushString(int handle, string value)

Parameters

handle int

value string

Returns

Task

Release(int)

Releases the ModEvent without sending it.

public static Task Release(int handle)

Parameters

handle int

Returns

Task

Send(int)

Sends the ModEvent and releases it. Returns true, if it was sent successfully, false if an error happened.

public static Task<bool> Send(int handle)

Parameters

handle int

Returns

Task<bool>