Class UICallbackScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from UICallback.psc.

UICallback allows passing arguments of different types to UI functions, unlike UI.Invoke*

public static class UICallbackScript

Inheritance

object

UICallbackScript

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, string)

Creates a new UICallback and returns the handle.

public static Task<int> Create(string menuName, string target)

Parameters

menuName string

target string

Returns

Task<int>

PushBool(int, bool)

public static Task PushBool(int handle, bool value)

Parameters

handle int

value bool

Returns

Task

PushBoolA(int, IReadOnlyCollection<bool>)

public static Task PushBoolA(int handle, IReadOnlyCollection<bool> args)

Parameters

handle int

args IReadOnlyCollection<bool>

Returns

Task

PushFloat(int, float)

public static Task PushFloat(int handle, float value)

Parameters

handle int

value float

Returns

Task

PushFloatA(int, IReadOnlyCollection<float>)

public static Task PushFloatA(int handle, IReadOnlyCollection<float> args)

Parameters

handle int

args IReadOnlyCollection<float>

Returns

Task

PushInt(int, int)

public static Task PushInt(int handle, int value)

Parameters

handle int

value int

Returns

Task

PushIntA(int, IReadOnlyCollection<int>)

public static Task PushIntA(int handle, IReadOnlyCollection<int> args)

Parameters

handle int

args IReadOnlyCollection<int>

Returns

Task

PushString(int, string)

public static Task PushString(int handle, string value)

Parameters

handle int

value string

Returns

Task

PushStringA(int, IReadOnlyCollection<string?>)

public static Task PushStringA(int handle, IReadOnlyCollection<string?> args)

Parameters

handle int

args IReadOnlyCollection<string>

Returns

Task

Release(int)

Releases the UICallback without sending it.

public static Task Release(int handle)

Parameters

handle int

Returns

Task

Send(int)

Invokes the UICallback and releases it. Returns true, if it was executed, false if an error happened.

public static Task<bool> Send(int handle)

Parameters

handle int

Returns

Task<bool>