Plugin

Overview

‘The Junk Drawer of UtilityBelt’ -Cosmic Jester

Commands

/ub

Prints current build version to chat

Examples:

• /ub - Prints current build version to chat

/ub help [command]

Prints help for UB command line usage

Examples:

• /ub help - Prints out all available UB commands * /ub help printcolors - Prints out help and usage information for the printcolors command

/ub opt {list | get <option> | set <option> <newValue> | toggle <options>}

Manage plugin settings from the command line

Examples:

• /ub opt list - Lists all available settings. * /ub get Plugin.Debug - Gets the current value for the “Plugin.Debug” setting * /ub toggle Plugin.Debug - Toggles the current value for the “Plugin.Debug” setting * /ub set Plugin.Debug true - Sets the “Plugin.Debug” setting to True

/ub date[utc] [format]

Prints current date with an optional format. See https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings for formatting options.

Examples:

• /ub date hh:mm:ss tt - Prints current local time ‘06:09:01 PM’ * /ub dateutc dddd dd MMMM - Prints current utc date ‘Friday 29 August’

/ub delay <millisecondDelay> <command>

Thinks to yourself with your current vitae percentage

Examples:

• /ub delay 5000 /say hello - Runs “/say hello” after a 3000ms delay (3 seconds)

/ub closestportal

Uses the closest portal.

Examples:

• /ub closestportal - Uses the closest portal

/ub portal[p] <portalName>

Portal commands, with build in VTank pausing.

Examples:

• /ub portal Gateway - Uses portal with exact name “Gateway” * /ub portalp Portal - Uses portal with name partially matching “Portal”

/ub follow[p] <name>

Follow player commands

Examples:

• /ub follow Zero Cool - Sets a VTank nav route to follow “Zero Cool” * /ub followp Zero - Sets a VTank nav route to follow a character with a name partially matching “Zero”

/ub mexec <expression>

Evaluates a meta expression

Examples:

• /ub mexec <expression> - Evaluates expression

/ub pos

Prints position information for the currently selected object

/ub printcolors

Prints out all available chat colors

Examples:

• /ub printcolors - Prints out all available chat colors

/ub propertydump

Prints information for the currently selected object

/ub playeroption (list|<option> {on | true | off | false})

Turns on/off acclient player options.

Examples:

• /ub playeroption AutoRepeatAttack on - Enables the AutoRepeatAttack player option.

/ub playsound [volume] <filepath>

Play a sound from the client

Examples:

• /ub playsound 100 C:\test.wav - Plays absolute path to music file at 100% volume * /ub playsound 50 test.wav - Plays test.wav from the UB plugin storage directory at 50% volume

/ub pcap {enable [bufferDepth] | disable | print}

Manage packet captures

Examples:

• /ub pcap enable - Enable pcap functionality (nothing will be saved until you call /ub pcap print) * /ub pcap print - Saves the current pcap buffer to a new file in your plugin storage directory.

/ub resolution <width> <height>

Set client resolution. This will take effect immediately, but will not change the settings page, or persist through relogging.

Examples:

• /ub resolution 640 600 - Set client resolution to 640 x 600

/ub textures <landscape[0-4]> <landscapeDetail[0-1]> <environment[0-4]> <environmentDetail[0-1]> <sceneryDraw[1-25]> <landscapeDraw[1-25]>

Sets Client texture options. This will take effect immediately, but will not change the settings page, or persist through relogging.

Examples:

• /ub textures 0 1 0 1 25 25 - Sets max settings * /ub textures 4 0 4 0 1 1 - Sets min settings

/ub vitae

Thinks to yourself with your current vitae percentage

/ub videopatch {enable | disable | toggle}

Disables rendering of the 3d world to conserve CPU

Examples:

• /ub videopatch enable - Enables the video patch * /ub videopatch disable - Disables the video patch * /ub videopatch toggle - Toggles the video patch

/ub swearallegiance[p][ <name|id|selected>]

Swear Allegiance

Examples:

• /ub swearallegiance Yonneh - Swear Allegiance to Yonneh * /ub swearallegiancep Yo - Swear Allegiance to a character with a name partially matching Yo. * /ub swearallegiance - Swear Allegiance to the closest character * /ub swearallegiance selected - Swear Allegiance to the selected character

/ub breakallegiance[p][ <name|id|selected>]

Break Allegiance (TODO: scan Allegiance Heirarchy, instead of visible)

Examples:

• /ub breakallegiance Yonneh - Break your Allegiance to Yonneh (noooooooooooo) * /ub breakallegiancep Yo - Break Allegiance from a character with a name partially matching Yo. * /ub breakallegiance - Break Allegiance from the closest character * /ub breakallegiance selected - Break Allegiance from the selected character

Settings

Plugin.CheckForUpdates

Default Value: True
Check for plugin updates on login

Plugin.Debug

Default Value: False
Show debug messages

Plugin.WindowPositionX

Default Value: 100
Main UB Window X position for this character (left is 0)

Plugin.WindowPositionY

Default Value: 100
Main UB Window Y position for this character (top is 0)

Plugin.PortalThink

Default Value: False
Think to yourself when portal use success/fail

Plugin.PortalTimeout

Default Value: 5000
Timeout to retry portal use

Plugin.PortalAttempts

Default Value: 3
Attempts to retry using a portal

Plugin.VideoPatch

Default Value: False
Patches the client (in realtime) to disable 3d rendering

Plugin.VideoPatchFocus

Default Value: False
Disables VideoPatch while the client has focus

Plugin.PCap

Default Value: False
Enables a rolling PCAP buffer, to export recent packets

Plugin.PCapBufferDepth

Default Value: 5000
PCap rolling buffer depth

Expression Methods

sin[number d]

Returns the sine of the specified angle.

Parameters:

• Param #0: d (number) - An angle, measured in radians.

Returns: number - Returns the sine of the specified angle.

sinh[number d]

Returns the hyperbolic sine of the specified angle.

Parameters:

• Param #0: d (number) - An angle, measured in radians.

Returns: number - Returns the hyperbolic sine of the specified angle.

sqrt[number d]

Returns the square root of a specified number.

Parameters:

• Param #0: d (number) - The number whose square root is to be found

Returns: number - Returns the square root of a specified number.

tan[number d]

Returns the tangent of the specified angle.

Parameters:

• Param #0: d (number) - An angle, measured in radians.

Returns: number - Returns the tangent of the specified angle.

tanh[number d]

Returns the hyperbolic tangent of the specified angle.

Parameters:

• Param #0: d (number) - An angle, measured in radians.

Returns: number - Returns the hyperbolic tangent of the specified angle.

vitae[]

Gets your character’s current vitae percentage as a number

Returns: number - Returns a number

Examples:

• vitae[] - returns your current vitae % as a number

wobjectfindnearestbytemplatetype[number templatetype]

Attempted to find the nearest landscape world object with the specified template type

Parameters:

• Param #0: templatetype (number) - templatetype to filter by

Returns: wobject - Returns a worldobject

Examples:

• wobjectfindnearestbytemplatetype[42137] - Returns a worldobject with templaye type 42137 (level 10 ice tachi warden)

wobjectgetintprop[wobject obj, number property]

Returns an int property from a specific world object, or 0 if it’s undefined

Parameters:

• Param #0: obj (wobject) - World object to get intproperty of
• Param #1: property (number) - IntProperty to return

Returns: number - Returns an int property value

Examples:

• wobjectgetintprop[wobjectgetselection[],218103808] - Returns the template type of the currently selected object

getheadingto[wobject obj]

Calculates the heading in degrees (0-360 clockwise, 0 is north) from your player to the target object

Parameters:

• Param #0: obj (wobject) - World object to calculate heading towards

Returns: number - Returns the heading in degrees from your player to the target object

Examples:

• getheadingto[wobjectgetselection[]] - Returns the heading in degrees from your player to the target object

getheading[wobject obj]

Returns the heading in degrees (0-360 clockwise, 0 is north) the target object is facing

Parameters:

• Param #0: obj (wobject) - World object to get the heading of

Returns: number - Returns the heading in degrees that the target object is facing

Examples:

• getheading[wobjectgetselection[]] - Returns the heading in degrees that your current selection is facing

acos[number d]

Returns the angle whos cosine is the specified number

Parameters:

• Param #0: d (number) - A number representing a cosine, where d must be greater than or equal to -1, but less than or equal to 1.

Returns: number - Returns the angle whos cosine is the specified number

asin[number d]

Returns the angle whose sine is the specified number

Parameters:

• Param #0: d (number) - A number representing a sine, where d must be greater than or equal to -1, but less than or equal to 1.

Returns: number - Returns the angle whose sine is the specified number

atan[number d]

Returns the angle whose tangent is the specified number.

Parameters:

• Param #0: d (number) - A number representing a tangent.

Returns: number - Returns the angle whose tangent is the specified number.

atan2[number y, number x]

Returns the angle whose tangent is the quotient of two specified numbers.

Parameters:

• Param #0: y (number) - The y coordinate of a point.
• Param #1: x (number) - The x coordinate of a point.

Returns: number - Returns the angle whose tangent is the quotient of two specified numbers.

cos[number d]

Returns the cosine of the specified angle.

Parameters:

• Param #0: d (number) - An angle, measured in radians.

Returns: number - Returns the cosine of the specified angle.

cosh[number d]

Returns the hyperbolic cosine of the specified angle.

Parameters:

• Param #0: d (number) - An angle, measured in radians.

Returns: number - Returns the hyperbolic cosine of the specified angle.