Class UIScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from UI.psc.

For functions that require a menuName, potential values are "InventoryMenu" "Console" "Dialogue Menu" "HUD Menu" "Main Menu" "MessageBoxMenu" "Cursor Menu" "Fader Menu" "MagicMenu" "Top Menu" "Overlay Menu" "Overlay Interaction Menu" "Loading Menu" "TweenMenu" "BarterMenu" "GiftMenu" "Debug Text Menu" "MapMenu" "Lockpicking Menu" "Quantity Menu" "StatsMenu" "ContainerMenu" "Sleep/Wait Menu" "LevelUp Menu" "Journal Menu" "Book Menu" "FavoritesMenu" "RaceSex Menu" "Crafting Menu" "Training Menu" "Mist Menu" "Tutorial Menu" "Credits Menu" "TitleSequence Menu" "Console Native UI Menu" "Kinect Menu"

public static class UIScript

Inheritance

object

UIScript

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

CloseCustomMenu()

close the custom menu if it's currently open.

public static Task CloseCustomMenu()

Returns

Task

GetBool(string, string)

public static Task<bool> GetBool(string menuName, string target)

Parameters

menuName string

target string

Returns

Task<bool>

GetFloat(string, string)

public static Task<float> GetFloat(string menuName, string target)

Parameters

menuName string

target string

Returns

Task<float>

GetInt(string, string)

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

Parameters

menuName string

target string

Returns

Task<int>

GetNumber(string, string)

DEPRECIATED

[Obsolete("UI.psc deprecates GetNumber, which calls GetFloat with the same arguments. Use GetFloat instead.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task<float> GetNumber(string menuName, string target)

Parameters

menuName string

target string

Returns

Task<float>

GetString(string, string)

public static Task<string> GetString(string menuName, string target)

Parameters

menuName string

target string

Returns

Task<string>

Invoke(string, string)

public static Task Invoke(string menuName, string target)

Parameters

menuName string

target string

Returns

Task

InvokeBool(string, string, bool)

public static Task InvokeBool(string menuName, string target, bool arg)

Parameters

menuName string

target string

arg bool

Returns

Task

InvokeBoolA(string, string, IReadOnlyCollection<bool>)

public static Task InvokeBoolA(string menuName, string target, IReadOnlyCollection<bool> args)

Parameters

menuName string

target string

args IReadOnlyCollection<bool>

Returns

Task

InvokeFloat(string, string, float)

public static Task InvokeFloat(string menuName, string target, float arg)

Parameters

menuName string

target string

arg float

Returns

Task

InvokeFloatA(string, string, IReadOnlyCollection<float>)

public static Task InvokeFloatA(string menuName, string target, IReadOnlyCollection<float> args)

Parameters

menuName string

target string

args IReadOnlyCollection<float>

Returns

Task

InvokeForm(string, string, IForm)

Sends Form data to Scaleform as a Flash object, FormLists included.

public static Task InvokeForm(string menuName, string target, IForm arg)

Parameters

menuName string

target string

arg IForm

Returns

Task

InvokeInt(string, string, int)

public static Task InvokeInt(string menuName, string target, int arg)

Parameters

menuName string

target string

arg int

Returns

Task

InvokeIntA(string, string, IReadOnlyCollection<int>)

public static Task InvokeIntA(string menuName, string target, IReadOnlyCollection<int> args)

Parameters

menuName string

target string

args IReadOnlyCollection<int>

Returns

Task

InvokeNumber(string, string, float)

DEPRECIATED

[Obsolete("UI.psc deprecates InvokeNumber, which calls InvokeFloat with the same arguments. Use InvokeFloat instead.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task InvokeNumber(string menuName, string target, float arg)

Parameters

menuName string

target string

arg float

Returns

Task

InvokeNumberA(string, string, IReadOnlyCollection<float>)

DEPRECIATED

[Obsolete("UI.psc deprecates InvokeNumberA, which calls InvokeFloatA with the same arguments. Use InvokeFloatA instead.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task InvokeNumberA(string menuName, string target, IReadOnlyCollection<float> args)

Parameters

menuName string

target string

args IReadOnlyCollection<float>

Returns

Task

InvokeString(string, string, string)

public static Task InvokeString(string menuName, string target, string arg)

Parameters

menuName string

target string

arg string

Returns

Task

InvokeStringA(string, string, IReadOnlyCollection<string?>)

public static Task InvokeStringA(string menuName, string target, IReadOnlyCollection<string?> args)

Parameters

menuName string

target string

args IReadOnlyCollection<string>

Returns

Task

IsMenuOpen(string)

Returns if the menu is currently open.

public static Task<bool> IsMenuOpen(string menuName)

Parameters

menuName string

Returns

Task<bool>

IsTextInputEnabled()

returns if scaleform is in 'text input' mode this is useful for ignoring keys that should get swallowed by an editable text box

public static Task<bool> IsTextInputEnabled()

Returns

Task<bool>

OpenCustomMenu(string, int)

open a custom menu named "CustomMenu" by loading the given swf from the interface folder (filename without extension) there can only be a single custom menu open at the same time

public static Task OpenCustomMenu(string swfPath, int flags = 0)

Parameters

swfPath string

flags int

Returns

Task

SetBool(string, string, bool)

public static Task SetBool(string menuName, string target, bool value)

Parameters

menuName string

target string

value bool

Returns

Task

SetFloat(string, string, float)

public static Task SetFloat(string menuName, string target, float value)

Parameters

menuName string

target string

value float

Returns

Task

SetInt(string, string, int)

public static Task SetInt(string menuName, string target, int value)

Parameters

menuName string

target string

value int

Returns

Task

SetNumber(string, string, float)

DEPRECIATED

[Obsolete("UI.psc deprecates SetNumber, which calls SetFloat with the same arguments. Use SetFloat instead.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task SetNumber(string menuName, string target, float value)

Parameters

menuName string

target string

value float

Returns

Task

SetString(string, string, string)

public static Task SetString(string menuName, string target, string value)

Parameters

menuName string

target string

value string

Returns

Task