schema: tags: O_ATTRIB: raw: '[O_ATTRIB]' description: > Property attribute for an object. parameters: - objectId: { type: OID, required: true } - name: { type: OANAME, required: true } - value: { type: STR, required: true } keys: primary: [objectId, name] foreign: [objectId] O_DELSCRIPT: raw: '[O_DELSCRIPT]' description: > A script was detached from an object parameters: - objectId: { type: OID, required: true } - scriptId: { type: SCID, required: true } keys: primary: [objectId, scriptId] foreign: [objectId, scriptId] O_GONE: raw: '[O_GONE]' description: > An object has left the place cacheGroup: '[O_HERE]' parameters: - objId: { type: OID, required: true } keys: primary: [objId] foreign: [objId] O_EFFECT: raw: '[O_EFFECT]' description: > An effect on an object, like a glow on mouseover. parameters: - objectId: { type: OID, required: true } - whenType: { type: STR, required: true } - styleName: { type: STR, required: true } - zDepth: { type: INT, required: true } - params: { type: QSTR, required: true } keys: primary: [objectId, whenType, styleName, zDepth] foreign: [objectId] O_DELEFFECT: raw: '[O_DELEFFECT]' description: > An effect was removed from object, like a glow on mouseover. cacheGroup: '[O_EFFECT]' parameters: - objectId: { type: OID, required: true } - whenType: { type: STR, required: true } - styleName: { type: STR, required: true } - zDepth: { type: INT, required: true } keys: primary: [objectId, whenType, styleName, zDepth] foreign: [objectId] O_CALLBACK: raw: '[O_CALLBACK]' description: > a scheduled callback to run on the object parameters: - objectId: { type: OID, required: true } - callbackId: { type: INT, required: true } - triggerName: { type: STR, required: true } - interval: { type: INT, required: true } keys: primary: [objectId] O_CHAT: raw: '[O_CHAT]' description: > A chat message that is said by this object. Expected to show in a chat bubble on the client. The message is url-encoded. parameters: - objectId: { type: OID, required: true } - channel: { type: STR, required: true } - message: { type: STR, required: true } keys: primary: [objectId] O_CHATSETTING: raw: '[O_CHATSETTING]' description: > Sets the value of a chat-system specific paramaeter for an object. parameters: - objectId: { type: OID, required: true } - name: { type: STR, required: true } - value: { type: STR, required: true } keys: primary: [objectId, name] O_DELCHATSETTINGS: raw: '[O_DELCHATSETTINGS]' description: > clears all of the chat setting for the object. parameters: - objectId: { type: OID, required: true } O_HERE: raw: '[O_HERE]' description: > A thing was in the place when you arrived. Note that objects with footprints larger than 1 are always drawn with the lower right corner in the tile specified by this x and y; they then stick out to the left. parameters: - objectId: { type: OID, required: true } - artIndex: { type: SPID, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - z: { type: FLT, required: true } - rotation: { type: STR, required: true } - name: { type: STR, required: true } - templateId: { type: TID, required: true } - blocking: { type: STR, required: true } - spritePath: { type: STR, required: true } keys: primary: [objectId] foreign: [objectId, artIndex, templateId] O_MOVE: raw: '[O_MOVE]' description: > Denotes an object is teleporting to the absolute world coordinates parameters: - objectId: { type: OID, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - z: { type: FLT, required: true } keys: primary: [objectId] foreign: [objectId] O_PATH: raw: '[O_PATH]' description: > Denotes an object is pathfinding parameters: - objId: { type: OID, required: true } - x1: { type: STR, required: true } - y1: { type: STR, required: true } - z1: { type: STR, required: true } - ms1: { type: STR, required: true } - x2: { type: STR, required: true } - y2: { type: STR, required: true } - z2: { type: STR, required: true } - ms2: { type: STR, required: true } keys: primary: [objectId] foreign: [objectId] O_PLAYER: raw: '[O_PLAYER]' description: > Set the object id for the users player parameters: - objectId: { type: OID, required: true } - userName: { type: STR, required: true } keys: primary: [objectId] foreign: [objectId] O_ROTATION: raw: '[O_ROTATION]' description: > Set an object's rotation and spin parameters: - objectId: { type: OID, required: true } - rotation: { type: STR, required: true } - spin: { type: STR, required: true } keys: primary: [objectId] foreign: [objectId] O_SAY: raw: '[O_SAY]' description: > Say the text message from object id parameters: - objectId: { type: OID, required: true } - message: { type: STR, required: true } keys: primary: [objectId] foreign: [objectId] O_SCRIPT: raw: '[O_SCRIPT]' description: > A script was attached to an object parameters: - objectId: { type: OID, required: true } - scriptId: { type: SCID, required: true } keys: primary: [objectId, scriptId] foreign: [objectId, scriptId] O_SCRIPTPARAM: raw: '[O_SCRIPTPARAM]' description: > Sets a parameter on the object for the attached script parameters: - objectId: { type: OID, required: true } - scriptId: { type: SCID, required: true } - paramName: { type: STR, required: true } - paramValue: { type: STR, required: true } keys: primary: [objectId, scriptId, paramName] foreign: [objectId, scriptId] O_SLIDE: raw: '[O_SLIDE]' description: > Denotes an object is sliding to the absolute world coordinates over time milliseconds parameters: - objectId: { type: OID, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - z: { type: FLT, required: true } - time: { type: INT, required: true } keys: primary: [objectId] foreign: [objectId] O_SPRITE: raw: '[O_SPRITE]' description: > Describes a sprite, and possibly a frame of animation parameters: - objectId: { type: OID, required: true } - spriteId: { type: SID, required: true } - spriteFrame: { type: STR, required: true } - spritePath: { type: STR, required: true } keys: primary: [objectId, spriteId] foreign: [objectId, spriteId] O_SPRITEREF: raw: '[O_SPRITEREF]' description: > Describes a sprite, and possibly a frame of animation parameters: - objectId: { type: OID, required: true } - spriteId: { type: SPID, required: true } - url: { type: STR, required: true } keys: primary: [objectId] foreign: [objectId, spriteId] O_SPRITEREF_PRELOAD: raw: '[O_SPRITEREF_PRELOAD]' description: > Describes a sprite, and possibly a frame of animation, to be preloaded parameters: - objectId: { type: OID, required: true } - spriteId: { type: SPID, required: true } - priority: { type: INT, required: true } - url: { type: STR, required: true } keys: primary: [objectId] foreign: [objectId, spriteId] O_SPRITESETTINGS: raw: '[O_SPRITESETTINGS]' description: > Changes settings on a sprite for an object. parameters: - objectId: { type: OID, required: true } - placeHolder: { type: STR, required: true } - scaleX: { type: FLT, required: true } - scaleY: { type: FLT, required: true } - maskRed: { type: INT, required: true } - maskGreen: { type: INT, required: true } - maskBlue: { type: INT, required: true } - originMode: { type: INT, required: true, enum: originMode } - mirrorMode: { type: INT, required: true, enum: mirrorStyle } keys: primary: [objectId] foreign: [objectId] O_SPRITELAYER: raw: '[O_SPRITELAYER]' description: > sets a layered sprite for an object for a slot parameters: - objectId: { type: OID, required: true } - spriteId: { type: SPID, required: true } - layer: { type: INT, required: true } - slot: { type: SLNAME, required: true } - fallbackSpriteId: { type: SPID, required: true } - spritePath: { type: STR, required: true } keys: primary: [objectId, slot] foreign: [objectId, spriteId] O_TINT: raw: '[O_TINT]' description: > tints a sprite slot for an object parameters: - objectId: { type: OID, required: true } - slot: { type: SLNAME, required: true } - style: { type: STR, required: true } - channel: { type: STR, required: true } - r: { type: INT, required: true } - g: { type: INT, required: true } - b: { type: INT, required: true } - paletteSpriteId: { type: SID, required: true } keys: primary: [objectId, slot] foreign: [objectId, slot, paletteSpriteId] O_DELTINT: raw: '[O_DELTINT]' description: > deletes tint from a sprite slot for an object parameters: - objectId: { type: OID, required: true } - slot: { type: SLNAME, required: true } keys: primary: [objectId, slot] foreign: [objectId, slot] O_SPRITEANIM: raw: '[O_SPRITEANIM]' description: > Describes sprite animation parameters: - objectId: { type: OID, required: true } - startFrame: { type: INT, required: true } - endFrame: { type: INT, required: true } - direction: { type: INT, required: true } - playStyle: { type: INT, required: true, enum: playStyle } - animDuration: { type: INT, required: true } keys: primary: [objectId] foreign: [objectId] O_PROP: raw: '[O_PROP]' description: > Describes a value of a script property for an object parameters: - objectId: { type: OID, required: true } - scriptId: { type: SCID, required: true } - name: { type: OPNAME, required: true } - value: { type: STR, required: true } keys: primary: [objectId, scriptId, name] foreign: [objectId, scriptId] O_SPRITELIGHT: raw: '[O_SPRITELIGHT]' description: > Attaches a spritelight to an object parameters: - lightId: { type: LHTID, required: true } - objectId: { type: OID, required: true } - spriteId: { type: SPID, required: true } - red: { type: INT, required: true } - green: { type: INT, required: true } - blue: { type: INT, required: true } - alpha: { type: FLT, required: true } - scaleX: { type: FLT, required: true } - scaleY: { type: FLT, required: true } - offsetX: { type: FLT, required: true } - offsetY: { type: FLT, required: true } - rotation: { type: FLT, required: true } keys: primary: [lightId, objectId] foreign: [objectId, spriteId] O_DELSPRITELAYER: raw: '[O_DELSPRITELAYER]' description: > deletes a layered sprite for an object for a slot parameters: - objectId: { type: OID, required: true } - slot: { type: STR, required: true } keys: primary: [objectId, slot] foreign: [objectId, slot] O_DELSPRITELIGHT: raw: '[O_DELSPRITELIGHT]' description: > Removes a spritelight from an object parameters: - objectId: { type: OID, required: true } - lightId: { type: LHTID, required: true } keys: primary: [objectId, lightId] foreign: [objectId, lightId] O_SELECT: raw: '[O_SELECT]' description: > Sets an object to be selected for the user parameters: - objectId: { type: OID, required: true } - styleName: { type: STR, required: true } - params: { type: QSTR, required: true } O_UNSELECT: raw: '[O_UNSELECT]' description: > Sets an object to not be selected for the user parameters: - objectId: { type: OID, required: true } O_VELOCITY: raw: '[O_VELOCITY]' description: > Details about an objects velocity vector. parameters: - objectId: { type: OID, required: true } - velocityX: { type: FLT, required: true } - velocityY: { type: FLT, required: true } - velocityZ: { type: FLT, required: true } - speed: { type: FLT, required: true } keys: primary: [objectId] foreign: [objectId] UI_CAPABILITY: raw: '[UI_CAPABILITY]' description: > cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - capability: { type: STR, required: true } keys: primary: [id, capability] foreign: [id] UI_EFFECT: raw: '[UI_EFFECT]' description: > add an effect to a ui element cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - whenType: { type: STR, required: true } - styleName: { type: STR, required: true } - params: { type: QSTR, required: true } keys: primary: [id] foreign: [id] UI_DELEFFECT: raw: '[UI_DELEFFECT]' description: > remove an effect from a ui element cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - whenType: { type: STR, required: true } - styleName: { type: STR, required: true } keys: primary: [id] foreign: [id] UI_DELETE: raw: '[UI_DELETE]' description: > cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } keys: primary: [id] foreign: [id] UI_ELEMENT: raw: '[UI_ELEMENT]' description: > Create UI element: A gadget that is just a container for other gadgets - nothing is drawn by default. Note that it can still be tinted, scaled, etc. A parent element can be any of the UI elements listed in UI Window Creation. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } keys: primary: [id] foreign: [parentId] UI_IMAGE: raw: '[UI_IMAGE]' description: > Create UI image element. It will draw with the upper left corner at the x and y position. The parent can be any of the UI element types. The width and height effectively scale the image; a width and height of zero means to use the art's actual size unaltered cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - artId: { type: SPID, required: true } keys: primary: [id] foreign: [parentId] UI_IMAGEREF: raw: '[UI_IMAGEREF]' description: > same as UI_IMAGE except that it refers to a URL directly instead of a sprite Id. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - url: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_IMAGEMAP: raw: '[UI_IMAGEMAP]' description: > Create UI image element. It will draw with the upper left corner at the x and y position. The parent can be any of the UI element types. The width and height effectively scale the image; a width and height of zero means to use the art's actual size unaltered. When clicked in client, send the command with x and y coordinates in local space. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - artId: { type: SPID, required: true } - frame: { type: INT, required: true } - command: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_IMAGEMAPREF: raw: '[UI_IMAGEMAPREF]' description: > Create UI image element. It will draw with the upper left corner at the x and y position. The parent can be any of the UI element types. The width and height effectively scale the image; a width and height of zero means to use the art's actual size unaltered. When clicked in client, send the command with x and y coordinates in local space. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - url: { type: STR, required: true } - frame: { type: INT, required: true } - command: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_LISTITEM: raw: '[UI_LISTITEM]' description: > An item in a list box. cacheGroup: '[UI_ELEMENT]' parameters: - parentId: { type: WINID, required: true } - itemId: { type: LITID, required: true } - text: { type: STR, required: true } - value: { type: STR, required: true } - artId: { type: SPID, required: true } keys: primary: [parentId, itemId] foreign: [parentId] UI_SLIDER: raw: '[UI_SLIDER]' description: > A slider widget with configurable step and tick. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - minValue: { type: FLT, required: true } - maxValue: { type: FLT, required: true } - step: { type: FLT, required: true } - tick: { type: FLT, required: true } - command: { type: STR, required: true } UI_VIDEOREF: raw: '[UI_VIDEOREF]' description: > an embedded streaming video referred to by a URL directly cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - url: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_IMAGEBUTTON: raw: '[UI_IMAGEBUTTON]' description: > A button type. Intended for things like macro buttons and the like that need pictures and don't have arguments cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - defaultArtId: { type: SPID, required: true } - hoverArtId: { type: SPID, required: true } - pressedArtId: { type: SPID, required: true } - command: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_IMAGEBUTTONREF: raw: '[UI_IMAGEBUTTONREF]' description: > same as UI_IMAGEBUTTON except that the images are URLs instead os spriteIds. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - defaultArtUrl: { type: STR, required: true } - hoverArtUrl: { type: STR, required: true } - pressedArtUrl: { type: STR, required: true } - command: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_TEXTBUTTON: raw: '[UI_TEXTBUTTON]' description: > A button with text and no image. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - windowStyle: { type: STR, required: true } - label: { type: STR, required: true } - command: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_SCROLLPANEL: raw: '[UI_SCROLLPANEL]' description: > A view into a larger scrollable region with scrollbars. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - panelWidth: { type: INT, required: true } - panelHeight: { type: INT, required: true } keys: primary: [id] foreign: [parentId] UI_LABEL: raw: '[UI_LABEL]' description: > Create UI text label element (one line labels). Text should be drawn from the top left cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - label: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_LINE: raw: '[UI_LINE]' description: > Create UI line element cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - endX: { type: STR, required: true } - endY: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_LINK: raw: '[UI_LINK]' description: > Same as UI_LABEL except that the text is clickable and launches a web browser for the specified URL. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - text: { type: STR, required: true } - url: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_LISTBOX: raw: '[UI_LISTBOX]' description: > A listbox with items in it. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - winstyle: { type: STR, required: true } - command: { type: STR, required: true } keys: primary: [id] foreign: [parentId, winstyle] UI_OVAL: raw: '[UI_OVAL]' description: > Create UI oval element. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } keys: primary: [id] foreign: [parentId] UI_RECT: raw: '[UI_RECT]' description: > Create UI rect element cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } keys: primary: [id] foreign: [parentId] UI_TEXTBOX: raw: '[UI_TEXTBOX]' description: > Create a text box UI widget. cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - red: { type: INT, required: true } - green: { type: INT, required: true } - blue: { type: INT, required: true } - backRed: { type: INT, required: true } - backGreen: { type: INT, required: true } - backBlue: { type: INT, required: true } - backAlpha: { type: FLT, required: true } - scroll: { type: BOOL, required: true } - autoScroll: { type: BOOL, required: true } - alignment: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_TEXTFIELD: raw: '[UI_TEXTFIELD]' description: > Creates a text field input element. When clicked on, it gains focus. Text may be typed into it. Text is only submitted to the server if the textfield is defined as a buttonfield for a specific button cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - textRedColor: { type: STR, required: true } - textGreenColor: { type: STR, required: true } - textBlueColor: { type: STR, required: true } - bgRed: { type: STR, required: true } - bgGreen: { type: STR, required: true } - bgBlue: { type: STR, required: true } - bgAlpha: { type: STR, required: true } - command: { type: STR, required: true } - defaultText: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_WINSTYLE: raw: '[UI_WINSTYLE]' description: > Defines a window style. Window styles are used by windows for framing. cacheGroup: '[UI_WINSTYLE]' parameters: - id: { type: WSID, required: true } - name: { type: STR, required: true } - tl: { type: STR, required: true } - tc: { type: STR, required: true } - tr: { type: STR, required: true } - ml: { type: STR, required: true } - mc: { type: STR, required: true } - mr: { type: STR, required: true } - bl: { type: STR, required: true } - bc: { type: STR, required: true } - br: { type: STR, required: true } keys: primary: [id] UI_DELWINSTYLE: raw: '[UI_DELWINSTYLE]' description: > deletes the definition of a window style. parameters: - id: { type: WSID, required: true } keys: primary: [id] foreign: [id] UI_WINDOW: raw: '[UI_WINDOW]' description: > Create UI window element. The window style references styles created with the UI_WINSTYLE tag. Modal and resizable windows are not yet implemented on any clients. Note that width and height include the borders, so the total window will be exactly whatever size you specify cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - windowStyle: { type: STR, required: true } keys: primary: [id] foreign: [parentId] UI_WORLD: raw: '[UI_WORLD]' description: > Create UI window that displays another world cacheGroup: '[UI_ELEMENT]' parameters: - id: { type: WINID, required: true } - parentId: { type: WINID, required: true } - name: { type: STR, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - scaleX: { type: FLT, required: true } - scaleY: { type: FLT, required: true } - worldName: { type: STR, required: true } - placeName: { type: STR, required: true } - showFocusRect: { type: INT, required: true } - shareSound: { type: INT, required: true } keys: primary: [id] foreign: [parentId] UI_HOVERWINDOW: raw: '[UI_HOVERWINDOW]' description: > Sets the popupWinId UI element to appear as a tool-tip hovering over the baseWinId Ui element when the mouse is over it. parameters: - baseWinId: { type: WINID, required: true } - popupWinId: { type: WINID, required: true } - delay: { type: INT, required: true } - hint: { type: STR, required: true } keys: foreign: [baseWinId, popupWinId] UI_HOVEROBJECT: raw: '[UI_HOVEROBJECT]' description: > Sets the popupWinId UI element to appear as a tool-tip hovering over the object when the mouse is over it. parameters: - object: { type: OID, required: true } - popupWinId: { type: WINID, required: true } - delay: { type: INT, required: true } - hint: { type: STR, required: true } keys: foreign: [object, popupWinId] HUD_MSG: raw: '[HUD_MSG]' description: > Sends a text message parameters: - time: { type: STR, required: true } - message: { type: STR, required: true } UI_BGCOLOR: raw: '[UI_BGCOLOR]' description: > Set the color of the background parameters: - red: { type: INT, required: true } - green: { type: INT, required: true } - blue: { type: INT, required: true } UI_BGSPRITE: raw: '[UI_BGSPRITE]' description: > Set a background image parameters: - artId: { type: SPID, required: true } - style: { type: INT, required: true, enum: bgStyle } - scaleX: { type: FLT, required: true } - scaleY: { type: FLT, required: true } UI_BGREF: raw: '[UI_BGREF]' description: > Set a background image with an image reference parameters: - url: { type: STR, required: true } - style: { type: INT, required: true, enum: bgStyle } - scaleX: { type: FLT, required: true } - scaleY: { type: FLT, required: true } UI_BUTTONFIELD: raw: '[UI_BUTTONFIELD]' description: > Mark a button as a field. parameters: - buttonId: { type: WINID, required: true } - fieldId: { type: WINID, required: true } keys: primary: [buttonId, fieldId] foreign: [buttonId, fieldId] UI_CURSOR: raw: '[UI_CURSOR]' description: > Set a custom cursor parameters: - artId: { type: SPID, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } UI_DELPARALLAXSPRITE: raw: '[UI_DELPARALLAXSPRITE]' description: > A parallax layer was deleted parameters: - id: { type: WINID, required: true } UI_PARALLAXSPRITE: raw: '[UI_PARALLAXSPRITE]' description: > Describes a parallax sprite parameters: - id: { type: WINID, required: true } - artId: { type: SPID, required: true } - worldX: { type: FLT, required: true } - worldY: { type: FLT, required: true } - depth: { type: STR, required: true } - moveX: { type: FLT, required: true } - moveY: { type: FLT, required: true } - scaleX: { type: FLT, required: true } - scaleY: { type: FLT, required: true } UI_ADDTEXT: raw: '[UI_ADDTEXT]' description: > Append text to a UI element parameters: - uiId: { type: WINID, required: true } - text: { type: STR, required: true } UI_ALIGN: raw: '[UI_ALIGN]' description: > Aligns a UI element parameters: - uiId: { type: WINID, required: true } - x: { type: INT, required: true } - y: { type: INT, required: true } - originMode: { type: STR, required: true } - scaleMode: { type: STR, required: true } UI_COLOR: raw: '[UI_COLOR]' description: > Change color/alpha of UI element. Note that this is inherited by children via multiply (e.g., making a white parent then a red child, then changing the parent to blue, will make the child purple) parameters: - uiId: { type: WINID, required: true } - red: { type: INT, required: true } - green: { type: INT, required: true } - blue: { type: INT, required: true } - alpha: { type: FLT, required: true } - subElement: { type: STR, required: true } UI_DELTINT: raw: '[UI_DELTINT]' description: > deletes tint from a ui element parameters: - uiId: { type: WINID, required: true } UI_VISIBLE: raw: '[UI_VISIBLE]' description: > Toggles the visibility of UI parameters: - uiId: { type: WINID, required: true } - visible: { type: STR, required: true } UI_WORLDSPACE: raw: '[UI_WORLDSPACE]' description: > Directs a UI to draw at its offset position relative to the in-world draw location of a specific object id. This can be used to make UI windows hover over/below/around in-world objects parameters: - uiId: { type: WINID, required: true } - objectId: { type: OID, required: true } keys: primary: [uiId, objectId] foreign: [uiId, objectId] UI_FOCUS: raw: '[UI_FOCUS]' description: > Sets the current focus to be the specified window. parameters: - uiId: { type: WINID, required: true } UI_TEXT: raw: '[UI_TEXT]' description: > sets the text in a ui window parameters: - uiId: { type: WINID, required: true } - text: { type: STR, required: true } UI_TINT: raw: '[UI_TINT]' description: > tints a ui element parameters: - uiId: { type: WINID, required: true } - uiTintStyle: { type: STR, required: true } - channel: { type: STR, required: true } - r: { type: INT, required: true } - g: { type: INT, required: true } - b: { type: INT, required: true } - paletteSpriteId: { type: SPID, required: true } UI_POSITION: raw: '[UI_POSITION]' description: > changes the position of a ui window. parameters: - uiId: { type: WINID, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } UI_SIZE: raw: '[UI_SIZE]' description: > parameters: - uiId: { type: WINID, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } UI_SLIDE: raw: '[UI_SLIDE]' description: > a Ui is sliding over time parameters: - uiId: { type: WINID, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - time: { type: STR, required: true } UI_SORT: raw: '[UI_SORT]' description: > a Ui should sort to front or back parameters: - uiId: { type: WINID, required: true } - sortType: { type: STR, required: true } UI_HOVERWINDOW: raw: '[UI_HOVERWINDOW]' description: > Makes the winId appear only when the mouse is over the parentId parameters: - winId: { type: WINID, required: true } - parentWinId: { type: WINID, required: true } - delayTime: { type: STR, required: true } - layoutHint: { type: STR, required: true } UI_URL: raw: '[UI_URL]' description: > changes the URL of a UI element. works with ImageRefs and Links. parameters: - uiId: { type: WINID, required: true } - url: { type: STR, required: true } UI_EVENT: raw: '[UI_EVENT]' description: > adds a client-side mouse event handler for UI element. parameters: - winId: { type: WINID, required: true } - eventType: { type: STR, required: true } - commands: { type: STR, required: true } - args: { type: STR, required: true } W_STYLE: raw: '[W_STYLE]' description: > defines a new UI style that contains style classes parameters: - styleId: { type: UISID, required: true } - name: { type: STR, required: true } - description: { type: STR, required: true } keys: primary: [styleId] W_DELSTYLE: raw: '[W_DELSTYLE]' description: > deletes a UI style parameters: - styleId: { type: SID, required: true } UI_STYLE: raw: '[UI_STYLE]' description: > applies a style to a hierarchy of windows parameters: - winId: { type: WINID, required: true } - styleId: { type: SID, required: true } UI_CLASS: raw: '[UI_CLASS]' description: > applies a class to a window parameters: - winId: { type: WINID, required: true } - className: { type: INT, required: true } UI_SCREEN_COLOR: raw: 'UI_SCREEN_COLOR' description: > applies a color blend operation to the screen parameters: - time: { type: INT, required: true } - r: { type: INT, required: true } - g: { type: INT, required: true } - b: { type: INT, required: true } - method: { type: STR, required: true } UI_SCREEN_MATRIX: raw: 'UI_SCREEN_MATRIX' description: > applies a matrix transform operation to the screen parameters: - time: { type: INT, required: true } - m1: { type: FLT, required: true } - m2: { type: FLT, required: true } - m3: { type: FLT, required: true } - m4: { type: FLT, required: true } - m5: { type: FLT, required: true } - m6: { type: FLT, required: true } - m7: { type: FLT, required: true } - m8: { type: FLT, required: true } - m9: { type: FLT, required: true } - m10: { type: FLT, required: true } - m11: { type: FLT, required: true } - m12: { type: FLT, required: true } - m13: { type: FLT, required: true } - m14: { type: FLT, required: true } - m15: { type: FLT, required: true } - m16: { type: FLT, required: true } - m17: { type: FLT, required: true } - m18: { type: FLT, required: true } - m19: { type: FLT, required: true } - m20: { type: FLT, required: true } UI_DELSCREEN: raw: 'UI_DELSCREEN' description: > clears the current screen effect parameters: - time: { type: INT, required: true } O_USERROLE: raw: '[O_USERROLE]' description: > Grants a role to a user parameters: - userId: { type: UID, required: true } - role: { type: STR, required: true } O_DELUSERROLE: raw: '[O_DELUSERROLE]' description: > Revokes a role from a user parameters: - userId: { type: UID, required: true } - role: { type: STR, required: true } S_BROWSE: raw: '[S_BROWSE]' description: > Sends a user to this URL parameters: - url: { type: STR, required: true } S_CONFIRM: raw: '[S_CONFIRM]' description: > Confirms that a command was successful parameters: - text: { type: STR, required: true } S_DEBUG: raw: '[S_DEBUG]' description: > FIXME - debug output for scripts? parameters: - timestamp: { type: STR, required: true } - scriptName: { type: STR, required: true } - triggerName: { type: STR, required: true } - targetId: { type: SID, required: true } - sourceId: { type: SID, required: true } - message: { type: STR, required: true } keys: primary: [timestamp, scriptName, triggerName, targetId, sourceId, message] S_DENY: raw: '[S_DENY]' description: > When a command cannot be executed [S_DENY] is sent down parameters: - message: { type: STR, required: true } S_ERROR: raw: '[S_ERROR]' description: > Error reporting parameters: - errorCode: { type: INT, required: true } - errorType: { type: STR, required: true } - operation: { type: STR, required: true } - details: { type: STR, required: true } S_PROFILE: raw: '[S_PROFILE]' description: > Report results of script profiling run parameters: - scriptName: { type: STR, required: true } - triggerName: { type: STR, required: true } - numCalls: { type: INT, required: true } - totalTime: { type: FLT, required: true } - averageTime: { type: FLT, required: true } - numInstructions: { type: INT, required: true } keys: primary: [scriptName, triggerName] S_GOTO: raw: '[S_GOTO]' description: > tells the client to goto a url of another world, or documents the new location within the current world. parameters: - url: { type: STR, required: true } S_HELPCMD: raw: '[S_HELPCMD]' description: > Contains the help description for a command parameters: - commandDescription: { type: STR, required: true } S_LOGIN: raw: '[S_LOGIN]' description: > confirms user login to the server parameters: - userId: { type: UID, required: true } - sessionId: { type: STR, required: true } S_LOGINQUEUE: raw: '[S_LOGINQUEUE]' description: > notification that user is login queued parameters: - position: { type: INT, required: true } - queueLength: { type: INT, required: true } S_LOGGEDIN: raw: '[S_LOGGEDIN]' description: > notifies the client that a user with this ID is already logged in, and prompts for /force_login parameters: - errorMessage: { type: STR, required: true } S_DISCONNECT: raw: '[S_DISCONNECT]' description: > notifies the client that the server has disconnected them deliberately. parameters: - errorMessage: { type: STR, required: true } S_PAUSE: raw: '[S_PAUSE]' description: > Pause status on the server parameters: - status: { type: STR, required: true } S_SINGLETOKEN: raw: '[S_SINGLETOKEN]' description: > Single use token for login sequence parameters: - userId: { type: UID, required: true } - tokenCode: { type: STR, required: true } S_TOKEN: raw: '[S_TOKEN]' description: > Token for login sequence parameters: - tokenCode: { type: STR, required: true } S_VERSION: raw: '[S_VERSION]' description: > FIXME - World version parameters: - buildVersion: { type: STR, required: true } - md5Version: { type: STR, required: true } - buildDate: { type: STR, required: true } - buildDir: { type: STR, required: true } S_TAGVERSION: raw: '[S_TAGVERSION]' description: > specifies the version of the tags in a tag-dump file parameters: - version: { type: STR, required: true } - saveDate: { type: STR, required: true } S_WORLD: raw: '[S_WORLD]' description: > FIXME - World information parameters: - worldId: { type: WID, required: true } - worldName: { type: STR, required: true } - startingPlace: { type: PID, required: true } - mode: { type: STR, required: true } - description: { type: STR, required: true } - zero: { type: INT, required: true} - owner: { type: STR, required: true } - cleanName: { type: STR, required: true } S_WORLDLIST: raw: '[S_WORLDLIST]' description: > A world with a running server parameters: - worldId: { type: WID, required: true } - name: { type: STR, required: true } - server: { type: STR, required: true } - port: { type: INT, required: true } - description: { type: STR, required: true, urlEncoded: true } - creator: { type: STR, required: true } - cleanName: { type: STR, required: true } S_WORLDSTATUS: raw: '[S_WORLDSTATUS]' description: > A world that is not yet started parameters: - world_name: { type: STR, required: true } - status: { type: STR, required: true } - message: { type: STR, required: true } - retry: { type: INT, required: true } P_SIZE: raw: '[P_SIZE]' description: > The dimensions of a place parameters: - width: { type: INT, required: true } - height: { type: INT, required: true} P_ANCHOR: raw: '[P_ANCHOR]' description: > Describes an anchor parameters: - anchorName: { type: STR, required: true } - anchorId: { type: SID, required: true } P_ASSETSCOMPLETE: raw: '[P_ASSETSCOMPLETE]' description: > Sent to client once all place assets have been sent parameters: - userId: { type: UID, required: true } - userName: { type: STR, required: true } P_AVATARSCALE: raw: '[P_AVATARSCALE]' description: > Sets the scale of the avatar relative to the tiles parameters: - scale: { type: STR, required: true } P_BLENDS: raw: '[P_BLENDS]' description: > Whether or not the global blends for the entire world are set (e.g., not per tile) parameters: - blend: { type: STR, required: true } P_CAMERA: raw: '[P_CAMERA]' description: > Sets the camera position, and sets the absolute size of the x axis for an isometric tile in 3d view. E.g, camera pitch. 256 = direct overhead, 128 = 45 degrees, etc. parameters: - x: { type: FLT, required: true } - y: { type: FLT, required: true } - z: { type: FLT, required: true } - angle: { type: FLT, required: true } - absolute: { type: INT, required: true } P_DELANCHOR: raw: '[P_DELANCHOR]' description: > An anchor was deleted parameters: - name: { type: STR, required: true } P_DELTILETYPE: raw: '[P_DELTILETYPE]' description: > A tile type was deleted parameters: - index: { type: TLID, required: true } keys: primary: [index] foreign: [index] P_DESC: raw: '[P_DESC]' description: > The description of a place parameters: - description: { type: STR, required: true } P_WATER: raw: '[P_WATER]' description: > A water plane (NOT USED) parameters: - id: { type: SID, required: true } P_ELEVCHANGE: raw: '[P_ELEVCHANGE]' description: > A tile's elevation parameters: - x: { type: FLT, required: true } - y: { type: FLT, required: true } - elevation: { type: STR, required: true } P_ELEVSCALE: raw: '[P_ELEVSCALE]' description: > Sets the pixel elevation increment for each notch in the elevation scale of the heightfield parameters: - scale: { type: STR, required: true } P_LOCKCAMERA: raw: '[P_LOCKCAMERA]' description: > Whether or not the user can adjust the view camera for this place parameters: - isLocked: { type: STR, required: true } P_LOCKSCROLL: raw: '[P_LOCKSCROLL]' description: > Whether or not the map scrolls when the user moves for this place parameters: - lockScroll: { type: STR, required: true } P_LOCKVIEW: raw: '[P_LOCKVIEW]' description: > Whether or not the user can adjust the view for this place parameters: - isLocked: { type: STR, required: true } P_LOCKZOOM: raw: '[P_LOCKZOOM]' description: > Whether or not the user can adjust the zoom for this place parameters: - isLocked: { type: STR, required: true } P_MAP: raw: '[P_MAP]' description: > Describes the url that points to a map image parameters: - mapURL: { type: STR, required: true } P_NAME: raw: '[P_NAME]' description: > The name of a place parameters: - name: { type: STR, required: true } P_RELIEF: raw: '[P_RELIEF]' description: > Toggles relief map drawing on and off for grid view parameters: - relief: { type: STR, required: true } P_START: raw: '[P_START]' description: > Starting location in place. parameters: - x: { type: FLT, required: true } - y: { type: FLT, required: true } - z: { type: FLT, required: true } P_TILE: raw: '[P_TILE]' description: > Describes a tile parameters: - index: { type: TLID, required: true } - url: { type: STR, required: true } - blocking: { type: INT, required: true } - blend: { type: STR, required: true } - movementRate: { type: FLT, required: true } - templateId: { type: TID, required: true } - tileName: { type: STR, required: true } keys: primary: [index] P_TILECHANGE: raw: '[P_TILECHANGE]' description: > A tile id changed parameters: - x: { type: INT, required: true } - y: { type: INT, required: true } - index: { type: TLID, required: true } P_TILECHUNK: raw: '[P_TILECHUNK]' description: > A batch of tile ids changed parameters: - x: { type: INT, required: true } - y: { type: INT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - indexList: { type: STR, required: true } P_ELEVCHUNK: raw: '[P_ELEVCHUNK]' description: > A batch of tile elevations changed. parameters: - x: { type: INT, required: true } - y: { type: INT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } - elevList: { type: STR, required: true } P_VIEW: raw: '[P_VIEW]' description: > FIXME - port the "Client Perspectives" page from the old wiki parameters: - view: { type: INT, required: true, enum: viewMode } P_VIEWPORT: raw: '[P_VIEWPORT]' description: > size and scale of client viewport parameters: - style: { type: INT, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } P_ZOOM: raw: '[P_ZOOM]' description: > The zoom level of the camera parameters: - zoom: { type: STR, required: true } W_ASSETSCOMPLETE: raw: '[W_ASSETSCOMPLETE]' description: > Done sending down asset URLs parameters: - userId: { type: UID, required: true } - userName: { type: STR, required: true } W_DEBUG: raw: '[W_DEBUG]' description: > Debug status on the server parameters: - status: { type: STR, required: true } W_SERVERMODE: raw: '[W_SERVERMODE]' description: > Server mode information parameters: - name: { type: STR, required: true } W_DELINPUT: raw: '[W_DELINPUT]' description: > Delete an input cacheGroup: '[W_INPUT]' parameters: - name: { type: STR, required: true } - id: { type: STR, required: true } W_DELMODULE: raw: '[W_DELMODULE]' description: > A module was deleted cacheGroup: '[W_MODULE]' parameters: - moduleId: { type: SID, required: true } keys: primary: [moduleId] foreign: [moduleId] W_DELMODULEITEM: raw: '[W_DELMODULEITEM]' description: > A module item was deleted parameters: - moduleId: { type: SID, required: true } - itemId: { type: STR, required: true } - itemType: { type: INT, required: true, enum: ssItemType } - userId: { type: UID, required: true } keys: primary: [moduleId, itemId] foreign: [moduleId, itemId] W_DELPLACE: raw: '[W_DELPLACE]' description: > A place was deleted cacheGroup: '[W_PLACELIST]' parameters: - placeId: { type: PID, required: true } - instanceId: { type: PINID, required: true } keys: primary: [placeId, instanceId] foreign: [placeId, instanceId] W_DELSCRIPT: raw: '[W_DELSCRIPT]' description: > A script was deleted cacheGroup: '[W_SCRIPTLIST]' parameters: - id: { type: STR, required: true } keys: primary: [id] foreign: [id] W_DELSOUND: raw: '[W_DELSOUND]' description: > A sound was deleted cacheGroup: '[W_SOUND]' parameters: - soundId: { type: SID, required: true } keys: primary: [soundId] foreign: [soundId] W_DELSPRITE: raw: '[W_DELSPRITE]' description: > A sprite was deleted cacheGroup: '[W_SPRITE]' parameters: - artId: { type: SPID, required: true } keys: primary: [artId] foreign: [artId] W_DELSPRITEANIM: raw: '[W_DELSPRITEANIM]' description: > Sprite animation was deleted parameters: - artId: { type: SPID, required: true } keys: primary: [artId] foreign: [artId] W_DELTEMPATTR: raw: '[W_DELTEMPATTR]' description: > An attribute from a template was deleted cacheGroup: '[W_TEMPATTR]' parameters: - templateId: { type: TID, required: true } - name: { type: TANAME, required: true } keys: primary: [templateId, name] foreign: [templateId, name] W_DELTEMPLATE: raw: '[W_DELTEMPLATE]' description: > A template was deleted cacheGroup: '[W_TEMPLATE]' parameters: - templateId: { type: TID, required: true } keys: primary: [templateId] foreign: [templateId] W_DELTEMPPARAM: raw: '[W_DELTEMPPARAM]' description: > A template parameter was deleted parameters: - templateId: { type: TID, required: true } - scriptId: { type: SCID, required: true } - paramName: { type: STR, required: true } W_DELTEMPSCRIPT: raw: '[W_DELTEMPSCRIPT]' description: > A script was detached from a template parameters: - templateId: { type: TID, required: true } - scriptId: { type: SCID, required: true } W_DESC: raw: '[W_DESC]' description: > The description of a world parameters: - description: { type: STR, required: true } W_GATE: raw: '[W_GATE]' description: > A gate that links two locations within a world. parameters: - gateId: { type: GID, required: true } - name: { type: STR, required: true } - direction: { type: STR, required: true } - preserveX: { type: BOOL, required: true } - preserveY: { type: BOOL, required: true } - sourcePlaceId: { type: PID, required: true } - sourcePosX: { type: FLT, required: true } - sourcePosY: { type: FLT, required: true } - sourcePosZ: { type: FLT, required: true } - sourceCollisionX: { type: FLT, required: true } - sourceCollisionY: { type: FLT, required: true } - sourceObjectId: { type: OID, required: true } - destinationPlaceId: { type: PID, required: true } - destinationPosX: { type: FLT, required: true } - destinationPosY: { type: FLT, required: true } - destinationPosZ: { type: FLT, required: true } - destinationCollisionX: { type: FLT, required: true } - destinationCollisionY: { type: FLT, required: true } - destinationObjectId: { type: OID, required: true } keys: primary: [gateId] foreign: [sourcePlaceId, sourceObjectId, destinationObjectId] W_DELGATE: raw: '[W_DELGATE]' description: > Delete a gate. cacheGroup: '[W_GATE]' parameters: - gateId: { type: GID, required: true } keys: primary: [gateId] foreign: [gateId] W_INPUT: raw: '[W_INPUT]' description: > FIXME parameters: - name: { type: STR, required: true } - id: { type: STR, required: true } - keyCode: { type: STR, required: true } - keyEvent: { type: STR, required: true } - keyMod: { type: STR, required: true } - command: { type: STR, required: true } W_LABEL: raw: '[W_LABEL]' description: > type = SIT_TEMPLATE = 1, SIT_SCRIPT = 2, SIT_SOUND = 3, SIT_SPRITE = 4, SIT_SKELETON = 5, SIT_PLACE = 6 parameters: - stylesheetItemType: { type: INT, required: true, enum: ssItemType } - styleSheetId: { type: SID, required: true } - labels: { type: CSV, required: true } W_MODULE: raw: '[W_MODULE]' description: > A module exported from or imported into this world parameters: - moduleId: { type: SID, required: true } - name: { type: STR, required: true } - importExport: { type: INT, required: true, enum: moduleImportExport } - worldId: { type: WID, required: true } - creator: {type: STR, required: false} keys: primary: [moduleId] W_MODULEITEM: raw: '[W_MODULEITEM]' description: > A stylesheet item associate with a module. Item types are 1 (template), 2 (script), 3 (sound), 4 (sprite), 5 (skeleton) parameters: - moduleId: { type: MID, required: true } - itemId: { type: SID, required: true } - itemType: { type: INT, required: true, enum: ssItemType } keys: primary: [moduleId, itemId] foreign: [moduleId] W_MODULEDEPEND: raw: '[W_MODULEDEPEND]' description: > Specifies that the leaf module depends on the required module. parameters: - leafModuleWorldId: { type: MID, required: true } - requiredModuleWorldId: { type: MID, required: true } keys: primary: [leafModuleWorldId, requiredModuleWorldId] foreign: [leafModuleWorldId, requiredModuleWorldId] W_DELMODULEDEPEND: raw: '[W_DELMODULEDEPEND]' description: > Specifies that the leaf module no longer depends on the required module. parameters: - leafModuleWorldId: { type: MID, required: true } - requiredModuleWorldId: { type: MID, required: true } keys: primary: [leafModuleWorldId, requiredModuleWorldId] foreign: [leafModuleWorldId, requiredModuleWorldId] W_NAME: raw: '[W_NAME]' description: > The name of a world parameters: - name: { type: STR, required: true } W_PLACE: raw: '[W_PLACE]' description: > Place description. When received, the client should immediately load this place parameters: - placeId: { type: SID, required: true } - placeObjId: { type: OID, required: true } keys: primary: [placeId] foreign: [placeObjId] W_PLACELIST: raw: '[W_PLACELIST]' description: > Place description parameters: - placeId: { type: PID, required: true } - placeName: { type: STR, required: true } - description: { type: STR, required: true } - instanceId: { type: PINID, required: true } - width: { type: INT, required: true } - height: { type: INT, required: true } keys: primary: [placeId, instanceId] foreign: [placeId, instanceId] W_PRIVILEGE: raw: '[W_PRIVILEGE]' description: > Privilege for role parameters: - roleId: { type: SID, required: true } - privilege: { type: STR, required: true } W_RESTART: raw: '[W_RESTART]' description: > Server restarting parameters: - event: { type: STR, required: true } W_ROLE: raw: '[W_ROLE]' description: > Role parameters: - id: { type: STR, required: true } - name: { type: STR, required: true } - desc: { type: STR, required: true } W_SCRIPTCMD: raw: '[W_SCRIPTCMD]' description: > The script has an implementation of this command parameters: - id: { type: STR, required: true } - name: { type: STR, required: true } W_SCRIPTCMDARG: raw: '[W_SCRIPTCMDARG]' description: > FIXME parameters: - id: { type: STR, required: true } - cmdName: { type: STR, required: true } - argName: { type: STR, required: true } - argType: { type: STR, required: true } W_SCRIPTCONSTANT: raw: '[W_SCRIPTCONSTANT]' description: > The script has an implementation of this constant parameters: - id: { type: STR, required: true } - constantName: { type: STR, required: true } - constantValue: { type: STR, required: true } W_SCRIPTFUNCTION: raw: '[W_SCRIPTFUNCTION]' description: > The script has an implementation of this function parameters: - id: { type: STR, required: true } - functionName: { type: STR, required: true } - comment: { type: STR, required: true } W_SCRIPTINCLUDE: raw: '[W_SCRIPTINCLUDE]' description: > The script includes the other specified script parameters: - scriptId: { type: SCID, required: true } - includedScriptId: { type: SCID, required: true } W_SCRIPTINPUT: raw: '[W_SCRIPTINPUT]' description: > The script has an implementation of this input parameters: - id: { type: STR, required: true } - inputName: { type: STR, required: true } - keyCode: { type: STR, required: true } - keyEvent: { type: STR, required: true } - keyMod: { type: STR, required: true } - command: { type: STR, required: true } W_SCRIPTLIST: raw: '[W_SCRIPTLIST]' description: > Describes a script parameters: - scriptId: { type: SCID, required: true } - name: { type: STR, required: true } - description: { type: STR, required: true } - persist: { type: INT, required: true } - spriteId: { type: SPID, required: true } - shortDesc: { type: STR, required: true } - license: { type: INT, required: true } keys: primary: [scriptId] foreign: [scriptId] W_SCRIPTPARAM: raw: '[W_SCRIPTPARAM]' description: > Specifies that this script has this parameter parameters: - id: { type: STR, required: true } - name: { type: STR, required: true } - type: { type: INT, required: true, enum: propertyType } - value: { type: STR, required: true } - exposed: { type: STR, required: true } - persist: { type: STR, required: true } W_SCRIPTPARAMDATA: raw: '[W_SCRIPTPARAMDATA]' description: > Meta-data associated with the script parameters: - id: { type: STR, required: true } - paramName: { type: STR, required: true } - name: { type: STR, required: true } - value: { type: STR, required: true } W_SCRIPTRELOAD: raw: '[W_SCRIPTRELOAD]' description: > Reload a script parameters: - id: { type: STR, required: true } W_STYLERELOAD: raw: '[W_STYLERELOAD]' description: > A style was reloaded parameters: - id: { type: STR, required: true } W_SCRIPTTRIGGER: raw: '[W_SCRIPTTRIGGER]' description: > The script has an implementation of this trigger parameters: - scriptId: { type: SCID, required: true } - triggerName: { type: STR, required: true } W_SOUND: raw: '[W_SOUND]' description: > A sound parameters: - id: { type: SNDID, required: true } - name: { type: STR, required: true } - url: { type: STR, required: true } keys: primary: [id] W_SPRITE: raw: '[W_SPRITE]' description: > Describes a piece of sprite art parameters: - spriteId: { type: SPID, required: true } - scaleX: { type: FLT, required: true } - scaleY: { type: FLT, required: true } - red: { type: INT, required: true, constraints: { minValue: 0, maxValue: 255 } } - green: { type: INT, required: true, constraints: { minValue: 0, maxValue: 255 } } - blue: { type: INT, required: true, constraints: { minValue: 0, maxValue: 255 } } - url: { type: STR, required: true, downloadType: IMG } - name: { type: STR, required: true } - originMode: { type: INT, required: true, enum: originMode } - mirrorMode: { type: INT, required: true, enum: mirrorStyle } - spritePath: { type: STR, required: true } - loadPriority: { type: INT, required: true } - originX: { type: FLT, required: true } - originY: { type: FLT, required: true } keys: primary: [spriteId] W_SPRITEANIM: raw: '[W_SPRITEANIM]' description: > Describes a sprite animation parameters: - spriteId: { type: SPID, required: true } - frames: { type: INT, required: true } - columns: { type: INT, required: true } - rows: { type: INT, required: true } - interval: { type: INT, required: true } - playStyle: { type: INT, required: true, enum: playStyle } keys: primary: [spriteId] W_TEMPATTR: raw: '[W_TEMPATTR]' description: > A new attribute was defined for a template parameters: - templateId: { type: TID, required: true } - name: { type: TANAME, required: true } - type: { type: INT, required: true, enum: propertyType } - defaultValue: { type: STR, required: true } - persist: { type: STR, required: true } keys: primary: [templateId, name] foreign: [templateId] W_TEMPLATE: raw: '[W_TEMPLATE]' description: > Template description parameters: - templateId: { type: TID, required: true } - templateParentId: { type: TID, required: true } - baseId: { type: TID, required: true } - kind: { type: INT, required: true, enum: templateKind } - name: { type: STR, required: true } - tickInterval: { type: STR, required: true } - spriteId: { type: SPID, required: true } - persist: { type: INT, required: true, enum: persistBehavior } - physical: { type: INT, required: true } - collisionShape: { type: INT, required: true, enum: collideShape } - collisionScaleX: { type: FLT, required: true } - collisionScaleY: { type: FLT, required: true } - collisionScaleZ: { type: FLT, required: true } - lockFacing: { type: BOOL, required: true } - skeletonId: { type: SID, required: true } - persistInterval: { type: INT, required: true } - blocking: { type: BOOL, required: true } - spritePath: { type: STR, required: true } - gmVisible: { type: BOOL, required: true } keys: primary: [templateId] foreign: [templateParentId, baseId, spriteId] W_TEMPPARAM: raw: '[W_TEMPPARAM]' description: > FIXME A template parameter parameters: - templateId: { type: TID, required: true } - scriptId: { type: SCID, required: true } - paramName: { type: STR, required: true } - attrVal: { type: STR, required: true } keys: primary: [templateId, scriptId, paramName] W_TEMPSCRIPT: raw: '[W_TEMPSCRIPT]' description: > A script was attached to a template parameters: - templateId: { type: TID, required: true } - scriptId: { type: SCID, required: true } - priority: { type: STR, required: true } keys: primary: [templateId, scriptId] W_PHYTICK: raw: '[W_PHYTICK]' description: > the time of the physics tick in a world in milliseconds parameters: - interval: { type: INT, required: true } W_START: raw: '[W_START]' description: > the start place for a world parameters: - place_id: { type: SID, required: true } A_SKELETON: raw: '[A_SKELETON]' description: > a skeleton parameters: - skeletonId: { type: SID, required: true } - name: { type: STR, required: true } - defaultAnim: { type: STR, required: true } A_BONE: raw: '[A_BONE]' description: > a bone in a skeleton parameters: - skeletonId: { type: SID, required: true } - boneId: { type: SID, required: true } - name: { type: STR, required: true } - spriteId: { type: SID, required: true } - parentBoneId: { type: SID, required: true } A_ANIMATION: raw: '[A_ANIMATION]' description: > an animation for a skeleton parameters: - skeletonId: { type: SID, required: true } - animId: { type: SID, required: true } - name: { type: STR, required: true } A_FRAME: raw: '[A_FRAME]' description: > a frame animation for a skeleton parameters: - skeletonId: { type: SID, required: true } - animId: { type: SID, required: true } - frame: { type: STR, required: true } - duration: { type: STR, required: true } A_BONEANIM: raw: '[A_BONEANIM]' description: > a bone in a frame animation for a skeleton parameters: - skeletonId: { type: SID, required: true } - animId: { type: SID, required: true } - boneAnimId: { type: SID, required: true } - boneId: { type: SID, required: true } - boneX: { type: STR, required: true } - boneY: { type: STR, required: true } - boneZ: { type: STR, required: true } - rotation: { type: STR, required: true } - boneScaleX: { type: STR, required: true } - boneScaleY: { type: STR, required: true } - visible: { type: STR, required: true } - spriteX: { type: STR, required: true } - spriteY: { type: STR, required: true } - spriteScaleX: { type: STR, required: true } - spriteScaleY: { type: STR, required: true } - spriteFrame: { type: STR, required: true } FX_PLAYSOUND: raw: '[FX_PLAYSOUND]' description: > parameters: - soundId: { type: SID, required: true } - handleId: { type: SID, required: true } - looping: { type: INT, required: true } - volume: { type: FLT, required: true } - objectId: { type: OID, required: true } - radius: { type: FLT, required: true } - callbackObjectId: { type: OID, required: true } keys: primary: [handleId, objectId] foreign: [soundId, objectId, callbackObjectId] FX_PLAYSOUNDREF: raw: '[FX_PLAYSOUNDREF]' description: > parameters: - url: { type: STR, required: true } - handleId: { type: SID, required: true } - looping: { type: INT, required: true } - volume: { type: FLT, required: true } - objectId: { type: OID, required: true } - radius: { type: FLT, required: true } - callbackObjectId: { type: OID, required: true } keys: primary: [handleId, objectId] foreign: [objectId, callbackObjectId] FX_STOPSOUND: raw: '[FX_STOPSOUND]' description: > none parameters: - soundId: { type: STR, required: true } keys: primary: [soundId] foreign: [soundId] FX_SOUNDVOLUME: raw: '[FX_SOUNDVOLUME]' description: > none parameters: - soundHandleId: { type: INT, required: true } - newVolume: { type: INT, required: true } - fadeInterval: { type: INT, required: true } keys: primary: [soundHandleId] foreign: [soundHandleId] INV_LEVEL: raw: '[INV_LEVEL]' description: > user has gained a level parameters: - userId: { type: INT, required: true } - worldId: { type: INT, required: true } - transactionKey: { type: STR, required: true } - levelDiff: { type: INT, required: true } - level: { type: INT, required: true } - nextXpRequired: { type: INT, required: true } - note: { type: STR, required: true } keys: primary: [userId] foreign: [userId, worldId] INV_GOLD: raw: '[INV_GOLD]' description: > users current gold amount has changed. parameters: - userId: { type: INT, required: true } - worldId: { type: INT, required: true } - transactionKey: { type: STR, required: true } - goldDiff: { type: INT, required: true } - gold: { type: INT, required: true } keys: primary: [userId] foreign: [userId, worldId] INV_XP: raw: '[INV_XP]' description: > user has gained experience. parameters: - userId: { type: INT, required: true } - worldId: { type: INT, required: true } - transactionKey: { type: STR, required: true } - xpType: { type: STR, required: true } - xpDiff: { type: INT, required: true } - xpSubTotal: { type: INT, required: true } - xpTotal: { type: INT, required: true } - note: { type: STR, required: true } keys: primary: [userId, xpType] foreign: [userId, worldId] INV_ALERT: raw: '[INV_ALERT]' description: > user has recieved an alert parameters: - alertType: { type: INT, required: true } - userId: { type: INT, required: true } - message: { type: STR, required: true } keys: primary: [alertType, userId, message] foreign: [userId] M_REPORT: raw: '[M_REPORT]' description: > a value for a limit within a world parameters: - limitType: { type: INT, required: true } - limitName: { type: STR, required: true } - value: { type: FLT, required: true } - limit: { type: FLT, required: true } D_BREAKP: raw: '[D_BREAKP]' description: > A breakpoint was set at a line in a script by a particular user. parameters: - scriptId: { type: SCID, required: true } - line: { type: INT, required: true } - userId: { type: UID, required: true } - userName: { type: STR, required: true } keys: primary: [scriptId, line] foreign: [scriptId, userId] D_DELBREAKP: raw: '[D_DELBREAKP]' description: > A breakpoint was removed from a line in a script by a particular user. cacheGroup: '[D_BREAKP]' parameters: - scriptId: { type: SCID, required: true } - line: { type: INT, required: true } - userId: { type: UID, required: true } - userName: { type: STR, required: true } keys: primary: [scriptId, line] foreign: [scriptId, userId] D_HALT: raw: '[D_HALT]' description: > Script execution has halted at the given script line. parameters: - scriptId: { type: SCID, required: true } - line: { type: INT, required: true } - operation: { type: STR, required: true } keys: primary: [scriptId, line] foreign: [scriptId] D_RESUME: raw: '[D_RESUME]' description: > Script execution has resumed from being halted. parameters: - userId: { type: UID, required: true } - userName: { type: STR, required: true } keys: primary: [userId] foreign: [userId] D_VAR: raw: '[D_VAR]' description: > A variable in the current execution context (usually while halted at a breakpoint). parameters: - scriptId: { type: SCID, required: true } - type: { type: INT, required: true } - scope: { type: INT, required: true } - name: { type: STR, required: true } - value: { type: STR, required: true } keys: primary: [scriptId, name] foreign: [scriptId] D_VARSCOMPLETE: raw: '[D_VARSCOMPLETE]' description: > The dump of variables for a halted context is complete. parameters: - scriptId: { type: SCID, required: true } - line: { type: INT, required: true } keys: primary: [scriptId, line] foreign: [scriptId] D_CONNECT: raw: '[D_CONNECT]' description: > A user successfully connected to a debugging socket. parameters: - userId: { type: UID, required: true } - userName: { type: STR, required: true } keys: primary: [userId] foreign: [userId] D_DISCONNECT: raw: '[D_DISCONNECT]' description: > A user was disconnected from a debugging socket. parameters: - userId: { type: UID, required: true } - userName: { type: STR, required: true } keys: primary: [userId] foreign: [userId] D_CALLSTACK: raw: '[D_CALLSTACK]' description: > Begin a debugging callstack. parameters: - id: { type: INT, required: true } keys: primary: [id] D_STACKFRAME: raw: '[D_STACKFRAME]' description: > A single frame of a debugging callstack. parameters: - frameId: { type: INT, required: true } - scriptId: { type: SCID, required: true } - scriptName: { type: STR, required: true } - line: { type: INT, required: true } - functionName: { type: STR, required: true } - oid: { type: OID, required: true } - args: { type: STR, required: true } keys: primary: [frameId] foreign: [scriptId,oid] D_STACKCOMPLETE: raw: '[D_STACKCOMPLETE]' description: > End a debugging callstack. parameters: - id: { type: INT, required: true } keys: primary: [id] D_AUDIT: raw: '[D_AUDIT]' description: > An object is being audited for detailed event monitoring. parameters: - userId: { type: UID, required: true } - objectId: { type: OID, required: true } - objectName: { type: STR, required: true } - auditMask: { type: INT, required: true } keys: primary: [userId,objectId] foreign: [userId,objectId] D_DELAUDIT: raw: '[D_DELAUDIT]' description: > An object is no longer being audited. cacheGroup: '[D_AUDIT]' parameters: - userId: { type: UID, required: true } - objectId: { type: OID, required: true } keys: primary: [userId,objectId] foreign: [userId,objectId] D_EVT: raw: '[D_EVT]' description: > A generic event was triggered by an audited object. parameters: - timestamp: { type: INT, required: true } - objectId: { type: OID, required: true } - eventName: { type: STR, required: true } - description: { type: STR, required: true } keys: primary: [timestamp,objectId] foreign: [objectId] D_PROP: raw: '[D_PROP]' description: > A property change event was triggered by an audited object. parameters: - timestamp: { type: INT, required: true } - objectId: { type: OID, required: true } - kind: { type: INT, required: true, enum: auditPropKind } - scriptId: { type: SCID, required: true } - type: { type: INT, required: true, enum: propertyType } - name: { type: STR, required: true } - value: { type: STR, required: true } keys: primary: [objectId,kind,name] foreign: [objectId,scriptId] D_SCRIPTATTACH: raw: '[D_SCRIPTATTACH]' description: > A script was attached or detached on an audited object. parameters: - timestamp: { type: INT, required: true } - objectId: { type: OID, required: true } - scriptId: { type: SCID, required: true } - scriptName: { type: STR, required: true } - eventName: { type: STR, required: true } keys: primary: [objectId,scriptId] foreign: [objectId,scriptId] D_TRIGGER: raw: '[D_TRIGGER]' description: > A trigger was fired on an audited object. parameters: - timestamp: { type: INT, required: true } - objectId: { type: OID, required: true } - scriptId: { type: SCID, required: true } - scriptName: { type: STR, required: true } - name: { type: STR, required: true } keys: primary: [objectId,scriptId,name] foreign: [objectId,scriptId] D_TRANSFORM: raw: '[D_TRANSFORM]' description: > An audited object was transformed (moved or rotated). parameters: - timestamp: { type: INT, required: true } - objectId: { type: OID, required: true } - x: { type: FLT, required: true } - y: { type: FLT, required: true } - z: { type: FLT, required: true } - rotation: { type: FLT, required: true } - time: { type: INT, required: true } keys: primary: [objectId] foreign: [objectId] D_PHYSICS: raw: '[D_PHYSICS]' description: > A physics change occurred on an audited object. parameters: - timestamp: { type: INT, required: true } - objectId: { type: OID, required: true } - velocityX: { type: FLT, required: true } - velocityY: { type: FLT, required: true } - velocityZ: { type: FLT, required: true } - speed: { type: FLT, required: true } - facing: { type: FLT, required: true } - spin: { type: FLT, required: true } keys: primary: [objectId] foreign: [objectId] D_PRESENCE: raw: '[D_PRESENCE]' description: > An audited object entered/left a place or anchor. parameters: - timestamp: { type: INT, required: true } - objectId: { type: OID, required: true } - eventName: { type: STR, required: true } - placeId: { type: PID, required: true } - placeInstanceId: { type: PINID, required: true } - placeName: { type: STR, required: true } - anchorName: { type: STR, required: true } keys: primary: [objectId] foreign: [objectId,placeId,placeInstanceId,anchorName]