Difference between revisions of "IConnectionIdentity"
From Virtual World Web Wiki
(Documentation for the IConnectionIdentity class) |
(Documentation for the IConnectionIdentity class) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | Represents a user connected to the system and a | + | Represents a user connected to the system and a [[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. |
| + | *'''Inherits interface: [[IConnectionIdentityBase]]''' | ||
| + | *'''Inherits interface: [[IIdentityBase]]''' | ||
===Remarks <nowiki>[</nowiki>[{{fullurl:IConnectionIdentity Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:IConnectionIdentity Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
{{#ifexist:IConnectionIdentity Remarks|{{:IConnectionIdentity Remarks}}|}} | {{#ifexist:IConnectionIdentity Remarks|{{:IConnectionIdentity Remarks}}|}} | ||
| Line 20: | Line 22: | ||
:: | :: | ||
::When on the instance host, if this connection is in a room, this property will return the instance member, even if the connection is not embodied | ::When on the instance host, if this connection is in a room, this property will return the instance member, even if the connection is not embodied | ||
| − | |||
| − | |||
| − | |||
| − | |||
:{{CSharp|IParticipant Participant {get;} }} | :{{CSharp|IParticipant Participant {get;} }} | ||
Latest revision as of 12:09, 30 April 2019
Represents a user connected to the system and a 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.
- Inherits interface: IConnectionIdentityBase
- Inherits interface: IIdentityBase
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
- IInstanceMember InstanceMember {get;}
- When on the instance host, if this connection is in a room, this property will return the instance member, even if the connection is not embodied
- IParticipant Participant {get;}
- When on the instance host, if this connection is in a room, and embodied, 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
- T GetSessionState<T>(string key, T defaultValue)
- Gets a session state value of the specified type, returning a default if it does not exist
- T GetSessionState<T>(string key)
- Gets a session state value of the specified type, or default(T) if it does not exist
- 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
- T RemoveSessionState<T>(string key)
- Removes a session state values from this connection
- void SetSessionState(string key, object value)
- Sets a session state value on this connection
- string ToString(string format)
- Gets the formated string version of this object
- bool TryGetController(out DOMController controller)
