UIScriptHandlerAttribute

From Virtual World Web Wiki
Jump to: navigation, search

Marks a class as a UI Script Handler

Remarks [edit]

Properties

bool AllowMultiple {get; set;}
True if this script can be sent to the same client multiple times resulting in multiple concurrent instances of your handler. If this property is false, sending a new copy of this script will result in any existing instances being auto-terminated.
Guid ClientScriptID {get; set;}
The ID of the ClientScript for which this type is the handler. ClientScripts are regsitered in the admin.
bool HandleCallbacks {get; set;}
True if this script handler wants a communication channel with the connected client so it can send and receive script messages
bool IsExtension {get; set;}
True if this handler is for an extension rather than a full-blown ClientScript
bool Recoverable {get; set;}
True if this script should survive a server change and it's Recover method should be called when that happens. If a handler is marked as recoverable all objects placed in the ScriptHandle's state collection must be marked Serializable
bool RequireJavascript {get; set;}
True if this script should not be sent to clients without a JavaScript engine (i.e. the ability to render UI)

Constructors

UIScriptHandlerAttribute(string clientScriptID)
Constructs a new UIScriptHandlerAttribute