Misc.rst

Misc

Methods

Play Beep system sound.

Cancel a prompt request.

Creates a snapshot of the current UO window.

• serial: Int32 Serial to check.

Check object from ignore list, return true if present. Can check Serial, Items or Mobiles

• itm: Item Item to check

• mob: Mobile Mobile to check

• name: String Name of the value.

Check if a shared value exixts.

Clear the Drag-n-Drop queue.

Clear ignore list from all object

Close the backpack. (OSI client only, no ClassicUO)

Close opened Old Menu.

• serial: Int32
• menu_name: String Name of the Entry as wirtten in-game.

• serial: Int32 Serial of the Entity
• respone_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.

• mob: Mobile
• menu_num: Int32

• mob: Mobile
• menu_name: String

• itm: Item
• menu_name: String

• itm: Item
• menu_num: Int32

Get the path to the Scripts directory.

Force client to disconnect.

• point_a: Point3D First coordinates.
• point_b: Point3D Second coordinates.

Compute the distance between 2 Point3D using pitagora's.

• 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.

• enable: Boolean True: enable seasons filter

* seasonFlag: 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.

Set UoClient window in focus or restore if minimized.

Get the position of the currently active Gump/Container. (OSI client only, no ClassicUO)

• serial: UInt32 Serial of the object.

Get MapInfo about a Mobile or Item using the serial

Get the title of title for open Old Menu.

Check if an Old Menu is open.

Check if have a prompt request.

Check if a have a query string menu opened, return true or false.

• serial: Int32 Serial to ignore.

Add an entiry to the ignore list. Can ignore Serial, Items or Mobiles.

• mob: Mobile Mobile to ignore

• itm: Item Item to ignore

Prompt the user with a Target. Open the inspector for the selected target.

Returns the latest HotKey recorded by razor as HotKeyEvent object.

• text: String Text to search.

Search in open Old Menu if contains a specific text.

• text: String Name of subitem to respond.

Perform a menu response by subitem name. If item not exist close menu.

Returns a point with the X and Y coordinates of the mouse relative to the UO Window

• posX: Int32 X screen coordinate.
• posY: Int32 Y screen coordinate.

Moves the mouse pointer to the position X,Y relative to the UO window

• 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)

Just do nothing and enjot the present moment.

Get the status of "No Run When Stealth" via scripting.

• enable: Boolean True: enable the option.

Set "No Run When Stealth" via scripting. Changes via scripting are not persistents.

Open the backpack. (OSI client only, no ClassicUO)

• millisec: Int32 Pause duration, in milliseconds.

Pause the script for a given amount of time.

• mob: Mobile Mobile object representing the pet.
• name: String

• serial: Int32 Serial of the pet.
• name: String New name to set.

Rename a specific pet.

• okcancel: Boolean OK Button
• response: 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.

Reset a prompt response.

• text: String Text of the response.

Response a prompt request. Often used to rename runes and similar.

Trigger a client ReSync.

• scriptfile: String Name of the script.

Run a script by file name, Script must be present in script grid.

• scriptfile: String

Get status of script if running or not, Script must be present in script grid.

• scriptfile: String Name of the script.

Stop a script by file name, Script must be present in script grid.

Stop all script running.

• msg: String
• wait: Boolean

• 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.

• obj: Object
• color: Int32

• num: Int32

• obj: Object

• num: UInt32

• msg: Double

• msg: Double
• color: Int32

• msg: Boolean

• num: Single

• num: Int32
• color: Int32

• num: UInt32
• color: Int32

• msg: Boolean
• color: Int32

• 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.

Get the name of the shard.

• mob: Mobile Item to unignore

• itm: Item Item to unignore.

• serial: Int32 Serial to unignore.

Remove object from ignore list. Can remove serial, items or mobiles

• 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.

• itm: Item Entity as Item object.
• delay: Int32

• mob: Mobile Entity as Item object.
• delay: Int32

• delay: Int32 Maximum wait, in milliseconds.

Pause script until server send an Old Menu, for a maximum amount of time.

• delay: Int32 Maximum wait time.

Wait for a prompt for a maximum amount of time.

• delay: Int32 Maximum wait, in milliseconds.

Pause script until server send query string request, for a maximum amount of time.