Struct StoryEventArgs

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

Arguments for OnStoryEvent.

public readonly struct StoryEventArgs : IEquatable<StoryEventArgs>

Implements

IEquatable<StoryEventArgs>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

StoryEventArgs(string, string, IReadOnlyList<StoryEventValue>)

Arguments for OnStoryEvent.

public StoryEventArgs(string Signature, string Name, IReadOnlyList<StoryEventValue> Values)

Parameters

Signature string

The four characters the game registers the kind under, such as "CRFT" for crafting and "KILL" for a killing. A plugin reads this to tell one kind from another.

Name string

The name the game gives the kind, such as "Craft Item".

Values IReadOnlyList<StoryEventValue>

One entry per value the kind declares, in the order it declares them.

Properties

Name

The name the game gives the kind, such as "Craft Item".

public string Name { get; init; }

Property Value

string

Signature

The four characters the game registers the kind under, such as "CRFT" for crafting and "KILL" for a killing. A plugin reads this to tell one kind from another.

public string Signature { get; init; }

Property Value

string

Values

One entry per value the kind declares, in the order it declares them.

public IReadOnlyList<StoryEventValue> Values { get; init; }

Property Value

IReadOnlyList<StoryEventValue>

Methods

Deconstruct(out string, out string, out IReadOnlyList<StoryEventValue>)

public void Deconstruct(out string Signature, out string Name, out IReadOnlyList<StoryEventValue> Values)

Parameters

Signature string

Name string

Values IReadOnlyList<StoryEventValue>

Equals(StoryEventArgs)

public bool Equals(StoryEventArgs other)

Parameters

other StoryEventArgs

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

GetValue(string)

Gets the value named name.

public StoryEventValue GetValue(string name)

Parameters

name string

The value's name, as Name reports it.

Returns

StoryEventValue

The value, and the first one where the name occurs twice.

Exceptions

ArgumentException

The kind declares no value named name. The message lists the declared names.

ToString()

public override string ToString()

Returns

string

Operators

operator ==(StoryEventArgs, StoryEventArgs)

public static bool operator ==(StoryEventArgs left, StoryEventArgs right)

Parameters

left StoryEventArgs

right StoryEventArgs

Returns

bool

operator !=(StoryEventArgs, StoryEventArgs)

public static bool operator !=(StoryEventArgs left, StoryEventArgs right)

Parameters

left StoryEventArgs

right StoryEventArgs

Returns

bool