Difference between revisions of "IUIScriptSystem"
From Virtual World Web Wiki
(Documentation for the IUIScriptSystem class) |
(Documentation for the IUIScriptSystem class) |
||
| Line 1: | Line 1: | ||
| + | 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 <nowiki>[</nowiki>[{{fullurl:IUIScriptSystem Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:IUIScriptSystem Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
{{:IUIScriptSystem Remarks}} | {{:IUIScriptSystem Remarks}} | ||
| Line 6: | Line 8: | ||
:{{CSharp|T GetHandlerInstance<T>(IConnectionIdentity identity)}} | :{{CSharp|T GetHandlerInstance<T>(IConnectionIdentity identity)}} | ||
| + | :: | ||
| + | ::Finds the instance of a given server-side UI script handler if one exists | ||
:{{CSharp|IUIScript GetHandlerInstance(Guid clientScriptID, IConnectionIdentity identity)}} | :{{CSharp|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 | ||
:{{CSharp|void ReleaseAll<T>(IConnectionIdentity identity)}} | :{{CSharp|void ReleaseAll<T>(IConnectionIdentity identity)}} | ||
| + | :: | ||
| + | ::Releases all scripts instances with a given handler type for a connection | ||
:{{CSharp|void ReleaseAll(Guid clientScriptID, IConnectionIdentity identity)}} | :{{CSharp|void ReleaseAll(Guid clientScriptID, IConnectionIdentity identity)}} | ||
| + | :: | ||
| + | ::Releases all scripts instances with a given client script ID for a connection | ||
:{{CSharp|void ReleaseAll(IConnectionIdentity identity)}} | :{{CSharp|void ReleaseAll(IConnectionIdentity identity)}} | ||
| + | :: | ||
| + | ::Removes all scripts for the given identity | ||
:{{CSharp|void ReleaseScope(IConnectionIdentity identity, Guid scopeID)}} | :{{CSharp|void ReleaseScope(IConnectionIdentity identity, Guid scopeID)}} | ||
| + | :: | ||
| + | ::Releases all script handles belonging to a given scope for a particular client connection | ||
:{{CSharp|IUIScriptHandle SendMissingTo<T>(IConnectionIdentity identity, object[] args)}} | :{{CSharp|IUIScriptHandle SendMissingTo<T>(IConnectionIdentity identity, object[] args)}} | ||
| + | :: | ||
| + | ::Sends a UIScript packet to the connection identity if it's not already sent | ||
:{{CSharp|IUIScriptHandle SendMissingTo<T, TEx>(IConnectionIdentity identity, object[] args)}} | :{{CSharp|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 | ||
:{{CSharp|IUIScriptHandle SendMissingTo<T>(Guid? scopeID, IConnectionIdentity identity, object[] args)}} | :{{CSharp|IUIScriptHandle SendMissingTo<T>(Guid? scopeID, IConnectionIdentity identity, object[] args)}} | ||
| + | :: | ||
| + | ::Sends a UIScript packet to the connection identity if it's not already sent | ||
:{{CSharp|bool SendServerMessage(IUIScriptHandle handle, object content)}} | :{{CSharp|bool SendServerMessage(IUIScriptHandle handle, object content)}} | ||
| + | :: | ||
| + | ::Sends a script message to the target handle | ||
:{{CSharp|IUIScriptHandle SendTo<T>(IConnectionIdentity identity, object[] args)}} | :{{CSharp|IUIScriptHandle SendTo<T>(IConnectionIdentity identity, object[] args)}} | ||
| + | :: | ||
| + | ::Sends a UIScript packet to the connection identity | ||
:{{CSharp|IUIScriptHandle SendTo<T, TEx>(IConnectionIdentity identity, object[] args)}} | :{{CSharp|IUIScriptHandle SendTo<T, TEx>(IConnectionIdentity identity, object[] args)}} | ||
| + | :: | ||
| + | ::Sends a UIScript packet to the connection identity with the specified extension | ||
:{{CSharp|IUIScriptHandle SendTo<T>(Guid? scopeID, IConnectionIdentity identity, object[] args)}} | :{{CSharp|IUIScriptHandle SendTo<T>(Guid? scopeID, IConnectionIdentity identity, object[] args)}} | ||
| + | :: | ||
| + | ::Sends a UIScript packet to the connection identity | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ | ||
Revision as of 20:02, 15 October 2016
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
