UOX3 Script Engine

Functions, Methods, Properties and Event handling

Item Properties

Property Purpose
account The account attached to this socket.
currentChar Returns the character this socket is currently logged in with as a JS-object.
idleTimeout Currently unused.
wasIdleWarned Returns true if character was warned before being disconnected, false if not.
tempInt Temporary variable to store larger numbers (supports negatives). Warning: This temporary variable is also used internally in UOX3's code to temporarily store stuff. Whatever you store here might get overwritten without warning, or you might overwrite other stuff if using it. Use with care!
tempInt2 A safe to use temporary variable to store larger numbers (supports negatives). This variant is not used by UOX3's code internally, and should be safe to use in JS without risk (other than from other scripts).
buffer Currently unused.
xText Temporary variable to store strings of text.
clickX Temporary variable to store small numbers (supports negatives).
clickY Temporary variable to store small numbers (supports negatives).
clickZ Temporary variables to store very small numbers (-128 to 128).
tempObj Temporary variable to store a Character or Item object. Warning: Also used by UOX3's code internally to temporarily store objects on socket. Use at your own risk!
tempObj2 A safe to use temporary variable to store a Character or Item object. This variant is not used by UOX3's code internally, and should be safe to use in JS without risk (other than from other scripts).
newClient
firstPacket Returns true if it's the first packet received.
cryptClient Returns true if client is set to crypt-mode, false if not.
clientIP Currently unused.
walkSequence Returns/Sets the point in the walk sequence of the socket.
currentSpellType Returns/Sets the current spell type of the socket.
logging
bytesSent
bytesReceived
targetOK
pickupX The X coordinate of the item picked up by socket.
pickupY The Y coordinate of the item picked up by socket.
pickupZ The Z coordinate of the item picked up by socket.
pickupSpot The locationtype the socket picked up an item from.
nowhere = 0
ground = 1
ownpack = 2
otherpack = 3
paperdoll = 4
bank = 5
pickupSerial Currently unused.
language Returns the unicode ID for the language used by client(?).
clientMajorVer
clientMinorVer
clientSubVer
clientLetterVer
clientType
target Returns the current/previous(?) target of the socket as a JS-object.
Original: ©Copyright 2000-2001 WWW.UOX3.NET (Daniel Stratton/Matthew Randall) ||| Rewrite: ©Copyright 2002 WWW.UOXDEV.DE (Florian "Rukus" Frick)