Difference between revisions of "IUIScriptSystem"
From Virtual World Web Wiki
(Documentation for the IUIScriptSystem class) |
(Documentation for the IUIScriptSystem class) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
===Methods=== | ===Methods=== | ||
| − | |||
| − | |||
:{{CSharp|T GetHandlerInstance<T>(IConnectionIdentity identity)}} | :{{CSharp|T GetHandlerInstance<T>(IConnectionIdentity identity)}} | ||
:: | :: | ||
| Line 14: | Line 12: | ||
:: | :: | ||
::Finds the instance of a given server-side UI script handler given its client script ID, if one exists | ::Finds the instance of a given server-side UI script handler given its client script ID, if one exists | ||
| + | |||
| + | :{{CSharp|T[] GetHandlerInstances<T>(IConnectionIdentity identity)}} | ||
| + | :: | ||
| + | ::Finds all instances of a given server-side UI script handler | ||
:{{CSharp|void ReleaseAll<T>(IConnectionIdentity identity)}} | :{{CSharp|void ReleaseAll<T>(IConnectionIdentity identity)}} | ||
| Line 42: | Line 44: | ||
:: | :: | ||
::Sends a UIScript packet to the connection identity if it's not already sent | ::Sends a UIScript packet to the connection identity if it's not already sent | ||
| + | |||
| + | :{{CSharp|void SendOrReleaseByPermission<T>(IConnectionIdentity identity, Guid permissionID)}} | ||
| + | :: | ||
| + | ::A convenience wrapper that checks an area permission and then calls either SendMissingTo or ReleaseAll for the script | ||
:{{CSharp|bool SendServerMessage(IUIScriptHandle handle, object content)}} | :{{CSharp|bool SendServerMessage(IUIScriptHandle handle, object content)}} | ||
Latest revision as of 17:37, 19 September 2018
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
- 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
- T[] GetHandlerInstances<T>(IConnectionIdentity identity)
- Finds all instances of a given server-side UI script handler
- 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
- void SendOrReleaseByPermission<T>(IConnectionIdentity identity, Guid permissionID)
- A convenience wrapper that checks an area permission and then calls either SendMissingTo or ReleaseAll for the script
- 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>(IConnectionIdentity identity, IEnumerable<Type> extensions, 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
