Class KeywordScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from Keyword.psc.

public static class KeywordScript

Inheritance

object

KeywordScript

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

GetKeyword(string)

SKSE64 additions built 2024-01-17 20:01:40.731000 UTC return the keyword with the specified key

public static Task<Keyword?> GetKeyword(string key)

Parameters

key string

Returns

Task<Keyword?>

GetString<T>(PapyrusScript<T>)

return the string value of the keyword

public static Task<string> GetString<T>(this PapyrusScript<T> self) where T : notnull, IPapyrusKeyword

Parameters

self PapyrusScript<T>

Returns

Task<string>

Type Parameters

T

SendStoryEventAndWait<T>(PapyrusScript<T>, Location?, IObjectReference?, IObjectReference?, int, int)

Sends this keyword as a story event to the story manager and waits for it to be processed. Returns true if a quest was started.

public static Task<bool> SendStoryEventAndWait<T>(this PapyrusScript<T> self, Location? akLoc = null, IObjectReference? akRef1 = null, IObjectReference? akRef2 = null, int aiValue1 = 0, int aiValue2 = 0) where T : notnull, IPapyrusKeyword

Parameters

self PapyrusScript<T>

akLoc Location?

akRef1 IObjectReference

akRef2 IObjectReference

aiValue1 int

aiValue2 int

Returns

Task<bool>

Type Parameters

T

SendStoryEvent<T>(PapyrusScript<T>, Location?, IObjectReference?, IObjectReference?, int, int)

Sends this keyword as a story event to the story manager

public static Task SendStoryEvent<T>(this PapyrusScript<T> self, Location? akLoc = null, IObjectReference? akRef1 = null, IObjectReference? akRef2 = null, int aiValue1 = 0, int aiValue2 = 0) where T : notnull, IPapyrusKeyword

Parameters

self PapyrusScript<T>

akLoc Location?

akRef1 IObjectReference

akRef2 IObjectReference

aiValue1 int

aiValue2 int

Returns

Task

Type Parameters

T