IUIScriptSystem

From Virtual World Web Wiki
Revision as of 21:05, 12 April 2017 by Spark5 (Talk | contribs) (Documentation for the IUIScriptSystem class)

Jump to: navigation, search

The UI script system is a primary layer one interface. It provides methods for working with UI scripts, sending them to clients, finding their instances, and releasing them.

Remarks [edit]

Methods

bool Find(IConnectionIdentity identity, ResourceValue resource, out IUIScriptHandle handle)
T GetHandlerInstance<T>(IConnectionIdentity identity)
Finds the instance of a given server-side UI script handler if one exists
IUIScript GetHandlerInstance(Guid clientScriptID, IConnectionIdentity identity)
Finds the instance of a given server-side UI script handler given its client script ID, if one exists
void ReleaseAll<T>(IConnectionIdentity identity)
Releases all scripts instances with a given handler type for a connection
void ReleaseAll(Guid clientScriptID, IConnectionIdentity identity)
Releases all scripts instances with a given client script ID for a connection
void ReleaseAll(IConnectionIdentity identity)
Removes all scripts for the given identity
void ReleaseScope(IConnectionIdentity identity, Guid scopeID)
Releases all script handles belonging to a given scope for a particular client connection
IUIScriptHandle SendMissingTo<T>(IConnectionIdentity identity, object[] args)
Sends a UIScript packet to the connection identity if it's not already sent
IUIScriptHandle SendMissingTo<T, TEx>(IConnectionIdentity identity, object[] args)
Sends a UIScript packet to the connection identity if it's not already sent, with the specified extension
IUIScriptHandle SendMissingTo<T>(Guid? scopeID, IConnectionIdentity identity, object[] args)
Sends a UIScript packet to the connection identity if it's not already sent
bool SendServerMessage(IUIScriptHandle handle, object content)
Sends a script message to the target handle
IUIScriptHandle SendTo<T>(IConnectionIdentity identity, object[] args)
Sends a UIScript packet to the connection identity
IUIScriptHandle SendTo<T, TEx>(IConnectionIdentity identity, object[] args)
Sends a UIScript packet to the connection identity with the specified extension
IUIScriptHandle SendTo<T>(Guid? scopeID, IConnectionIdentity identity, object[] args)
Sends a UIScript packet to the connection identity