Misc
¶
Methods¶
- Misc.Beep() → Void¶
Play Beep system sound.
- Misc.CancelPrompt() → Void¶
Cancel a prompt request.
- Misc.CaptureNow() → Void¶
Creates a snapshot of the current UO window.
- Misc.CheckIgnoreObject(serial) → Boolean¶
serial:
Int32
Serial to check.
Check object from ignore list, return true if present. Can check Serial, Items or Mobiles
- Misc.CheckIgnoreObject(itm) → Boolean¶
itm:
Item
Item to check
- Misc.CheckIgnoreObject(mob) → Boolean¶
mob:
Mobile
Mobile to check
name:
String
Name of the value.
Check if a shared value exixts.
- Misc.ClearDragQueue() → Void¶
Clear the Drag-n-Drop queue.
- Misc.ClearIgnore() → Void¶
Clear ignore list from all object
- Misc.CloseBackpack() → Void¶
Close the backpack. (OSI client only, no ClassicUO)
- Misc.CloseMenu() → Void¶
Close opened Old Menu.
- Misc.ContextReply(serial, menu_name) → Void¶
serial:
Int32
menu_name:
String
Name of the Entry as wirtten in-game.
- Misc.ContextReply(serial, respone_num) → Void¶
serial:
Int32
Serial of the Entityrespone_num:
Int32
Poition of the option in the menu. Starts from 0.
Respond to a context menu on mobile or item. Menu ID is base zero, or can use string of menu text.
- Misc.ContextReply(mob, menu_num) → Void¶
mob:
Mobile
menu_num:
Int32
- Misc.ContextReply(mob, menu_name) → Void¶
mob:
Mobile
menu_name:
String
- Misc.ContextReply(itm, menu_name) → Void¶
itm:
Item
menu_name:
String
- Misc.ContextReply(itm, menu_num) → Void¶
itm:
Item
menu_num:
Int32
- Misc.CurrentScriptDirectory() → String¶
Get the path to the Scripts directory.
- Misc.Disconnect() → Void¶
Force client to disconnect.
- Misc.DistanceSqrt(point_a, point_b) → Double¶
Compute the distance between 2 Point3D using pitagora’s.
- Misc.ExportPythonAPI(path, pretty) → Void¶
path:
String
Name of the output file. (default: Config/AutoComplete.json )pretty:
Boolean
Print a readable JSON. (default: True )
Return a string containing list RE Python API list in JSON format.
- Misc.FilterSeason(enable, seasonFlag) → Void¶
enable:
Boolean
True: enable seasons filterseasonFlag:
UInt32
0: Spring (default fallback)
1: Summer 2: Fall 3: Winter 4: Desolation
Enable or disable the Seasons filter forcing a specific season Season filter state will be saved on logout but not the season flag that will be recovered.
- Misc.FocusUOWindow() → Void¶
Set UoClient window in focus or restore if minimized.
- Misc.GetContPosition() → Point¶
Get the position of the currently active Gump/Container. (OSI client only, no ClassicUO)
- Misc.GetMapInfo(serial) → Misc.MapInfo¶
serial:
UInt32
Serial of the object.
Get MapInfo about a Mobile or Item using the serial
- Misc.GetMenuTitle() → String¶
Get the title of title for open Old Menu.
- Misc.HasMenu() → Boolean¶
Check if an Old Menu is open.
- Misc.HasPrompt() → Boolean¶
Check if have a prompt request.
- Misc.HasQueryString() → Boolean¶
Check if a have a query string menu opened, return true or false.
- Misc.IgnoreObject(serial) → Void¶
serial:
Int32
Serial to ignore.
Add an entiry to the ignore list. Can ignore Serial, Items or Mobiles.
- Misc.IgnoreObject(mob) → Void¶
mob:
Mobile
Mobile to ignore
- Misc.IgnoreObject(itm) → Void¶
itm:
Item
Item to ignore
- Misc.Inspect() → Void¶
Prompt the user with a Target. Open the inspector for the selected target.
- Misc.LastHotKey() → HotKeyEvent¶
Returns the latest HotKey recorded by razor as HotKeyEvent object.
- Misc.MenuContain(text) → Boolean¶
text:
String
Text to search.
Search in open Old Menu if contains a specific text.
- Misc.MenuResponse(text) → Void¶
text:
String
Name of subitem to respond.
Perform a menu response by subitem name. If item not exist close menu.
- Misc.MouseLocation() → Point¶
Returns a point with the X and Y coordinates of the mouse relative to the UO Window
- Misc.MouseMove(posX, posY) → Void¶
posX:
Int32
X screen coordinate.posY:
Int32
Y screen coordinate.
Moves the mouse pointer to the position X,Y relative to the UO window
- Misc.NextContPosition(x, y) → Void¶
x:
Int32
X coordinate.y:
Int32
Y coordinate.
Return the X,Y of the next container, relative to the game window. (OSI client only, no ClassicUO)
- Misc.NoOperation() → Void¶
Just do nothing and enjot the present moment.
- Misc.NoRunStealthStatus() → Boolean¶
Get the status of “No Run When Stealth” via scripting.
- Misc.NoRunStealthToggle(enable) → Void¶
enable:
Boolean
True: enable the option.
Set “No Run When Stealth” via scripting. Changes via scripting are not persistents.
- Misc.OpenPaperdoll() → Void¶
Open the backpack. (OSI client only, no ClassicUO)
- Misc.Pause(millisec) → Void¶
millisec:
Int32
Pause duration, in milliseconds.
Pause the script for a given amount of time.
- Misc.PetRename(mob, name) → Void¶
mob:
Mobile
Mobile object representing the pet.name:
String
- Misc.PetRename(serial, name) → Void¶
serial:
Int32
Serial of the pet.name:
String
New name to set.
Rename a specific pet.
- Misc.QueryStringResponse(okcancel, response) → Void¶
okcancel:
Boolean
OK Buttonresponse:
String
Cancel Button
Perform a query string response by ok or cancel button and specific response string.
name:
String
Name of the value.
Get a Shared Value, if value not exist return null. Shared values are accessible by every script.
name:
String
Name of the value.
Remove a Shared Value.
- Misc.ResetPrompt() → Void¶
Reset a prompt response.
- Misc.ResponsePrompt(text) → Void¶
text:
String
Text of the response.
Response a prompt request. Often used to rename runes and similar.
- Misc.Resync() → Void¶
Trigger a client ReSync.
- Misc.ScriptRun(scriptfile) → Void¶
scriptfile:
String
Name of the script.
Run a script by file name, Script must be present in script grid.
- Misc.ScriptStatus(scriptfile) → Boolean¶
scriptfile:
String
Get status of script if running or not, Script must be present in script grid.
- Misc.ScriptStop(scriptfile) → Void¶
scriptfile:
String
Name of the script.
Stop a script by file name, Script must be present in script grid.
- Misc.ScriptStopAll() → Void¶
Stop all script running.
- Misc.SendMessage(msg, wait) → Void¶
msg:
String
wait:
Boolean
- Misc.SendMessage(msg, color, wait) → Void¶
msg:
String
The object to print.color:
Int32
Color of the message.wait:
Boolean
True: Wait for confimation. - False: Returns instatnly.
Send a message to the client.
- Misc.SendMessage(obj, color) → Void¶
obj:
Object
color:
Int32
- Misc.SendMessage(num) → Void¶
num:
Int32
- Misc.SendMessage(obj) → Void¶
obj:
Object
- Misc.SendMessage(num) → Void¶
num:
UInt32
- Misc.SendMessage(msg) → Void¶
msg:
Double
- Misc.SendMessage(msg, color) → Void¶
msg:
Double
color:
Int32
- Misc.SendMessage(msg) → Void¶
msg:
Boolean
- Misc.SendMessage(num) → Void¶
num:
Single
- Misc.SendMessage(num, color) → Void¶
num:
Int32
color:
Int32
- Misc.SendMessage(num, color) → Void¶
num:
UInt32
color:
Int32
- Misc.SendMessage(msg, color) → Void¶
msg:
Boolean
color:
Int32
- Misc.SendToClient(keys) → Void¶
keys:
String
List of keys.
Send to the client a list of keystrokes. Can contain control characters: - Send Control+Key: ctrl+u: ^u - Send ENTER: {Enter} Note: some keys don’t work with ClassicUO (es: {Enter} )
name:
String
Name of the value.value:
Object
Value to set.
Set a Shared Value by specific name, if value exist he repalce value. Shared values are accessible by every script.
- Misc.ShardName() → String¶
Get the name of the shard.
- Misc.UnIgnoreObject(mob) → Void¶
mob:
Mobile
Item to unignore
- Misc.UnIgnoreObject(itm) → Void¶
itm:
Item
Item to unignore.
- Misc.UnIgnoreObject(serial) → Void¶
serial:
Int32
Serial to unignore.
Remove object from ignore list. Can remove serial, items or mobiles
- Misc.WaitForContext(serial, delay) → List[Misc.Context]¶
serial:
Int32
Serial of the entity.delay:
Int32
Maximum wait.
Wait for Context Menu to appear, for a maximum amount of time. Usable on an Item or Mobile.
- Misc.WaitForContext(itm, delay) → List[Misc.Context]¶
itm:
Item
Entity as Item object.delay:
Int32
- Misc.WaitForContext(mob, delay) → List[Misc.Context]¶
mob:
Mobile
Entity as Item object.delay:
Int32
- Misc.WaitForMenu(delay) → Boolean¶
delay:
Int32
Maximum wait, in milliseconds.
Pause script until server send an Old Menu, for a maximum amount of time.
- Misc.WaitForPrompt(delay) → Boolean¶
delay:
Int32
Maximum wait time.
Wait for a prompt for a maximum amount of time.
- Misc.WaitForQueryString(delay) → Boolean¶
delay:
Int32
Maximum wait, in milliseconds.
Pause script until server send query string request, for a maximum amount of time.