Difference between revisions of "IConnectionIdentity"
From Virtual World Web Wiki
(Documentation for the IConnectionIdentity class) |
(Documentation for the IConnectionIdentity class) |
||
Line 1: | Line 1: | ||
− | Represents a user connected to the system and a [[Layer One]] [[Connection Identity]] | + | Represents a user connected to the system and a [[Layer One]] [[Connection Identity]] from the [[Instance Host|Instance Host's]] point of view. Provides identity details (entity memberships), current location and [[Participant]], and provides access to many other Layer One objects related to the connection. |
===Remarks <nowiki>[</nowiki>[{{fullurl:IConnectionIdentity Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:IConnectionIdentity Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
Line 8: | Line 8: | ||
:: | :: | ||
::Access to the ability manager for the connection. use this to create, enable, disable, and fire abilities | ::Access to the ability manager for the connection. use this to create, enable, disable, and fire abilities | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
:{{CSharp|IExperienceData ExperienceData {get;} }} | :{{CSharp|IExperienceData ExperienceData {get;} }} | ||
Line 24: | Line 16: | ||
:: | :: | ||
::Gets the current instance context | ::Gets the current instance context | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
:{{CSharp|IParticipant Participant {get;} }} | :{{CSharp|IParticipant Participant {get;} }} | ||
:: | :: | ||
::When on the instance host, if this connection is in a room, this property will return a reference to the participant | ::When on the instance host, if this connection is in a room, this property will return a reference to the participant | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
:{{CSharp|ConcurrentDictionary<string, object> SessionState {get;} }} | :{{CSharp|ConcurrentDictionary<string, object> SessionState {get;} }} | ||
Line 52: | Line 28: | ||
:: | :: | ||
::Gets the currently Targeted object | ::Gets the currently Targeted object | ||
− | |||
− | |||
− | |||
− | |||
:{{CSharp|IValidationContext ValidationContext {get;} }} | :{{CSharp|IValidationContext ValidationContext {get;} }} | ||
Line 62: | Line 34: | ||
===Methods=== | ===Methods=== | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
:{{CSharp|DOMController GetController()}} | :{{CSharp|DOMController GetController()}} | ||
:: | :: | ||
Line 85: | Line 41: | ||
:: | :: | ||
::Gets the currently selected DOMObject collection | ::Gets the currently selected DOMObject collection | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
:{{CSharp|void MoveToObject(long objectID, float minDistance, bool pathTo)}} | :{{CSharp|void MoveToObject(long objectID, float minDistance, bool pathTo)}} | ||
:: | :: | ||
::Requests that the client make best effort to move the player's avatar next to and facing the requested object | ::Requests that the client make best effort to move the player's avatar next to and facing the requested object | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
:{{CSharp|string ToString(string format)}} | :{{CSharp|string ToString(string format)}} |
Revision as of 12:31, 23 May 2018
Represents a user connected to the system and a Layer One Connection Identity from the Instance Host's point of view. Provides identity details (entity memberships), current location and Participant, and provides access to many other Layer One objects related to the connection.
Remarks [edit]
Properties
- IAbilitySet AbilitySet {get;}
- Access to the ability manager for the connection. use this to create, enable, disable, and fire abilities
- IExperienceData ExperienceData {get;}
- Gets client experience metrics for this connection
- IInstanceContext InstanceContext {get;}
- Gets the current instance context
- IParticipant Participant {get;}
- When on the instance host, if this connection is in a room, this property will return a reference to the participant
- ConcurrentDictionary<string, object> SessionState {get;}
- A collection of objects that should be marshalled between servers with the session
- DOMObject Target {get;}
- Gets the currently Targeted object
- IValidationContext ValidationContext {get;}
- Represents the Instance's currently visible ObjectContainers
Methods
- DOMController GetController()
- Looks up this connections current DOMController object from it's persona view
- IEnumerable<DOMObject> GetObjectSelection()
- Gets the currently selected DOMObject collection
- void MoveToObject(long objectID, float minDistance, bool pathTo)
- Requests that the client make best effort to move the player's avatar next to and facing the requested object
- string ToString(string format)
- Gets the formated string version of this object
- bool TryGetController(out DOMController controller)