Interactions

Interactions Class

Documentation for this section has not yet been entered.

Syntax

[Sansar.Script.Interface]
public class Interactions : Sansar.Script.InstanceInterface, IEnumerable<Interaction>

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Members

See Also: Inherited members from Sansar.Script.InstanceInterface.

Public Properties

[read-only]
 
Count uint . Documentation for this section has not yet been entered.
 
Enabled bool . Documentation for this section has not yet been entered.
[read-only]
 
IsValid bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.)
[read-only]
default property
 
Item (uint) Interaction . Get an Interaction by index
[read-only]
 
Prompt string . Documentation for this section has not yet been entered.

Public Methods

 
GetEnumerator () : IEnumerator<Interaction>
IEnumerable interface.
 
Subscribe (Action<InteractionData>, bool) : Sansar.Script.IEventSubscription
Subscribes to Interactions Events.
override
ToString () : string
A string representation of this object.

Explicitly Implemented Interface Members

 
IEnumerable.GetEnumerator Documentation for this section has not yet been entered.

Member Details

Count Property

Documentation for this section has not yet been entered.

Syntax

[get: Sansar.Script.Interface]
public uint Count { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Enabled Property

Documentation for this section has not yet been entered.

Syntax

[get: Sansar.Script.Interface]
[set: Sansar.Script.Interface]
public bool Enabled { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetEnumerator Method

IEnumerable interface.

Syntax

[Sansar.Script.Interface]
public IEnumerator<Interaction> GetEnumerator ()

Returns

An IEnumerator

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Item Property

Get an Interaction by index

Syntax

This is the default property for this class.

[Sansar.Script.Interface]
public Interaction this [uint index] { get; }

Parameters

index
The index of the Interaction to get

Value

The corresponding Interaction.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Prompt Property

Documentation for this section has not yet been entered.

Syntax

[get: Sansar.Script.Interface]
public string Prompt { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Subscribe Method

Subscribes to Interactions Events.

Syntax

[Sansar.Script.Interface]
public Sansar.Script.IEventSubscription Subscribe (Action<InteractionData> callback, bool persistent)

See Also

Parameters

callback
Callback which is executed when the event completes.
persistent
Optional, set to false to unsubscribe after one event.

Returns

Documentation for this section has not yet been entered.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

System.Collections.IEnumerable.GetEnumerator Method

Documentation for this section has not yet been entered.

Syntax

[Sansar.Script.Interface]
IEnumerator System.Collections.IEnumerable.GetEnumerator ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

ToString Method

A string representation of this object.

Syntax

[Sansar.Script.Interface]
public override string ToString ()

Returns

A string representation of this object.

Remarks

The format of this string may change between releases.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.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.