Difference between revisions of "IConnectionIdentity"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the IConnectionIdentity class)
(Documentation for the IConnectionIdentity class)
Line 41: Line 41:
 
::
 
::
 
::Gets the currently selected DOMObject collection
 
::Gets the currently selected DOMObject collection
 +
 +
:{{CSharp|T GetSessionState<T>(string key, T defaultValue)}}
 +
::
 +
::Gets a session state value of the specified type, returning a default if it does not exist
 +
 +
:{{CSharp|T GetSessionState<T>(string key)}}
 +
::
 +
::Gets a session state value of the specified type, or default(T) if it does not exist
  
 
:{{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|T RemoveSessionState<T>(string key)}}
 +
::
 +
::Removes a session state values from this connection
 +
 +
:{{CSharp|void SetSessionState(string key, object value)}}
 +
::
 +
::Sets a session state value on this connection
  
 
:{{CSharp|string ToString(string format)}}
 
:{{CSharp|string ToString(string format)}}

Revision as of 18:09, 1 June 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
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)