ScriptEventData

ScriptEventData Class

Result of a ScriptBase.PostScriptEvent(ScriptId, string, Reflective) call.

Syntax

public class ScriptEventData : EventData

Remarks

Requirements

Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from EventData.

Public Properties

[read-only]
 
Data Reflective . The data passed by ScriptBase.PostScriptEvent(ScriptId, string, Reflective).
[read-only]
 
Message string . The message the event was created with.
[read-only]
 
SourceScriptId ScriptId . The id of the script which generated the event.

Public Methods

override
ToString () : string
Generates a string representation of the EventData. (Inherited from EventData.)

Member Details

Data Property

Syntax

public Reflective Data { get; }

Value

May be null.

Remarks

 

Requirements

Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0

Message Property

The message the event was created with.

Syntax

public string Message { get; }

Value

This string should always match the corresponding ScriptBase.SubscribeToScriptEvent(string, Action<Sansar.Script.ScriptEventData>,System.Boolean) call.

Remarks

 

Requirements

Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0

SourceScriptId Property

The id of the script which generated the event.

Syntax

public ScriptId SourceScriptId { get; }

Value

Remarks

 

Requirements

Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.