SimpleScriptEventData

SimpleScriptEventData Class

Used by ScriptBase.PostSimpleScriptEvent(string, object) to send simple script events.

Syntax

public class SimpleScriptEventData : Reflective

Remarks

Supports sending a single Sansar or System type object between scripts, without the overhead of creating a custom Reflective class and Interface pair. Used by PostSimpleScriptEvent and SimpleScript.OnScriptEvent.

Requirements

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

Members

See Also: Inherited members from Reflective.

Public Constructors

 
Default constructor.

Public Properties

 
Data object . A single object to pass between scripts.

Protected Properties

[read-only]
 
AllowedContexts Reflective.Context . Internal Use Only. Overridden by subclasses to return only those contexts requested which are allowed for that type of script. (Inherited from Reflective.)
[read-only]
 
ReflectiveContexts Reflective.Context . Override ReflectiveContexts to limit which contexts this Reflective interface is available in when registered with. (Inherited from Reflective.)
[read-only]
 
ReflectiveName string . Override ReflectiveName to change which name this class will be registered as in the Reflective system. (Inherited from Reflective.)

Public Methods

 
AsInterface<TInterface> () : TInterface
Returns a TInterface object if one can be created, null otherwise (Inherited from Reflective.)
 
FullInterface (string) : string
Generates a string which shows all the members which can be reflected. (Inherited from Reflective.)
 
Register ()
Register this object to be found with Sansar.Simulation.ScenePrivate.FindReflective(string) (Inherited from Reflective.)
 
Unregister ()
Unregister this object so it will not be found with Sansar.Simulation.ScenePrivate.FindReflective(string) (Inherited from Reflective.)

Member Details

SimpleScriptEventData Constructor

Default constructor.

Syntax

public SimpleScriptEventData ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Data Property

A single object to pass between scripts.

Syntax

public object Data { get; set; }

Value

Remarks

To be useful, Data must be a system or Sansar type and not a locally defined type. Locally defined types will not be usable by other scripts.

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.