Non categorized commands Orion Assistant - Hotride/OrionUO GitHub Wiki

Command format:

ReturnType NameSpace.name(requiredParameters, [optionalParameters=defaultValue]);

ReturnType - the return value of the function (void - the function returns nothing);
NameSpace - the scope of the function;
name - the name of the function;
requiredParameters - required parameters;
optionalParameters - optional parameters, the default value is indicated after the = sign

void Orion.SaveConfig();

Save configuration.

void Orion.SetLight(state, [value=currentLight]);

Set the light level.

state - state turn on/turn off.

value - light level value from 0 to 31.

void Orion.SetWeather(state, [index=currentWeather], [effectsCount=currentCount], [temperature=currentTemperature]);

Set weather conditions.

state - state turn on/turn off.

index - ordinal number of the weather effect.

effectsCount - number of effects on screen.

temperature - not used.

void Orion.SetSeason(state, [index=currentIndex], [musicIndex=currentMusic]);

Set season with number.

state - state turn on/turn off.

index - ordinal number of season.

musicIndex - music number for playback.

void Orion.Track([state=false], [x=-1, y=-1]);

Hide/show quest arrow to the indicated coordinates. -1 in coordinates indicates current location in the world.

state - state show/hide.

x - coordinate X in the world, where the arrow points

y - coordinate Y в мире, where the arrow points

bool Orion.SaveHotkeys('fileName');

Save current hotkey set with file name 'filename' (to the Hotkeys folder at the root of the assistant).

Result: true on successful file save.

bool Orion.LoadHotkeys('fileName');

Load hotkey set with file name 'fileName' (from the Hotkeys folder at the root of the assistant).

Result: true on successful file load.

void Orion.Cast(spellIndex/'spellName', ['targetSerial']);

Cast a spell 'spellName' (You can also refer to the order number in the spellbook).

If targetSerial is specified - automatically use the target on this object, otherwise - only sends a cast request to the server.

void Orion.UseSkill(skillIndex/'skillName', ['targetSerial']);

Use skill 'skillName' (You can also refer to the order number).

If targetSerial is specified - automatically use the target on this object, otherwise - only sends a request to use skill to the server.

int Orion.SkillValue(skillIndex/'skillName', ['type'=real]);

Get skill value 'skillName' (You can also refer to the order number).

type - value type: real, base, cap, lock.

Result: Integer value of the skill (e.g: 3.0 will be 30, 10.3 - 103, 50.8 - 508, 100.0 - 1000).

void Orion.CloseUO();

Close game client.

void Orion.WarMode([state=switch]);

Switch war mode.

state - turn on/turn off war mode. If not specified - switches the current state.

void Orion.Morph(['graphic'=0]);

Change character body graphic.

Without parameters or 0 - returns body to its original state.

void Orion.Resend();

Synchronisation with the server. Can be used every few seconds.

void Orion.Sound(index);

Play sound index.

void Orion.EmoteAction('actionName');

Request to emotion reproducing actionName.

void Orion.Print(['color'], 'text');

Display in system chat

If displayed only 1 argument - string color will be standard.

color - message color.

text - text.

void Orion.CharPrint('serial', 'color', 'text');

Display message above the character

serial - serial of the character, above who you want to display the message

color - message color

text - text.

void Orion.Say('text');

Say in the chat 'text'

bool Orion.BuffExists('name');

Checking for buffs by name or graphic.

Result: true if buff is active.

void Orion.SetFontColor(state, ['color'=0x02B2]);

Change text color for player character and state of this option.

state - true/false.

color - text color.

bool Orion.GetFontColor();

Retrieve status of text replacement option for player character.

Returns true if option is enabled.

String Orion.GetFontColorValue();

Retrieve text replacement color for player character.

Returns: text color.

void Orion.SetCharactersFontColor(state, ['color'=0x02B2]);

Change text color used by characters for output and state of this option.

state - true/false.

color - text color.

bool Orion.GetCharactersFontColor();

Retrieve status of text replacement option for characters.

Returns true if option is enabled.

String Orion.GetCharactersFontColorValue();

Retrieve text replacement color for all characters.

Returns: text color.

Introduced in 2.0.7.0

void Orion.UseAbility('abilityName');

Use request for an ability 'abilityName'.

'abilityName' can also be 'Primary', 'Secondary', or its real name in(can also be found in script editor context menu) or it can be ability index starting from '0' and '30' as last index.

void Orion.UseWrestlingDisarm();

Wrestling Disarm ability use request.

void Orion.UseWrestlingStun();

Wrestling Stun ability use request..

Introduced in 2.0.8.0

void Orion.InvokeVirture('name');

...

Introduced in 2.0.9.0

void Orion.PlayWav('filePath');

Play a *.WAV file from filePath.

Introduced in 2.0.12.0

void Orion.Screenshot();

Create a screenshot.

Introduced in 2.0.13.0

void Orion.LogOut();

Client log out ( client will remain running, at login screen ).

MacroObject Orion.CreateClientMacro(['action'], ['subAction']);

Create a macro in client options.

Returns MacroObject or null reference.

Introduced in 2.0.14.0

void Orion.OpenPaperdoll('serial');

Open paperdoll by serial.

void Orion.ClosePaperdoll('serial');

Close paperdoll by serial.

void Orion.MovePaperdoll('serial', x, y);

Move paperdoll by serial to chosen x and y coordinates on screen.

Introduced in 2.0.15.0

void Orion.ClientViewRange(range);

Set clients view range ( 5 is minimal, 25 is maximal ).

int Orion.ClientViewRange();

Get current client view range.

Returns clients view range in tiles.

void Orion.LoadProfile('name');

Load OA profile by name.

Introduced in 3.0.0.0

void Orion.StopMacro();

Stop playing the assistant macro.

void Orion.AddDisplayTimer('id', timer, [position='RightTop'], [shape='Circle|Bar'], [name=''], [x=0], [y=0], [textColor='0xFFFF'], [font=0xFF], [backgroundColor='0xFFFFFFFE']);

Draw a display timer in the client window.

- id - string, timer identifier for further interaction with it;
- timer - the number of how many milliseconds the timer will be displayed (and count down);
- position - line, timer position, it can be: Left, Right, Top, Bottom, LeftTop, RightTop, LeftBottom, RightBottom, AboveChar (above the character), UnderChar (under the character), Custom (custom position, set to x, y );
- shape - line, timer figure, may be Circle, Rectangle, Line. May have the addition of Bar, then the timer will be animatedly reduced as it approaches zero;
- name - string, name of the timer to be displayed. May be an empty string;
- x, y - for Custom timers - screen coordinates, for other types - offset of the timer relative to its position on the screen;
- textColor - Timer text color, 0xFFFF - use standard color;
- font - Text font, 0xFF - use a standard font;
- backgroundColor - timer background color, 0xFFFFFFFE - use standard color.

bool Orion.DisplayTimerExists('id');

Check for the existence of a display timer in the client with the specified id.

Result: true if the timer is displayed.

void Orion.RemoveDisplayTimer('id');

Delete the display timer with the specified id.

void Orion.Boxhack('serial');

Block closing the automatic container serial (manually, by right-clicking, it closes).

bool Orion.AbilityStatus('name');

Get the status of the name.

name can be 'primary' and 'secondary'.

Result: true if the ability is active.

bool Orion.SpellStatus('name');

Get the state of the name spell.

Result: true if the spell is active.

void Orion.SetSkillStatus('name', 'status');

Set the growth state of the skill name to status.

status can be 'Up', 'Down', 'Lock'.

void Orion.PlayMacro('name');

Run an assistant macro named name (case sensitive).

int Orion.GetPing('name');

Get the ping value calculated by the client (only when the ping check option is enabled).

name can be:

- 'min' - minimum ping;
- 'max' - maximum ping;
- 'average' - the average ping value.

Result: ping value (9999 if ping was not requested).

String Orion.RegRead('varName', [subKey='Software\OrionAssistant\vars']);

Read the string value from the registry for the varName variable.

Result: a value from the registry, or an empty string.

bool Orion.RegWrite('varName', 'value', [subKey='Software\OrionAssistant\vars']);

Write the string value value to the registry for the varName variable.

Result: true if recording was successful, false if errors occurred and data was not written.

void Orion.InfoBuff();

Log information about current buffs and debuffs.

int Orion.BuffCount();

Result: The total number of buffs and debuffs per character.

void Orion.CopyToClipboard('text');

Copy text to clipboard.

void Orion.DisplayTimerSetRadius('id', radius);

Set the radius for the display timer (only for circular timers).

void Orion.DisplayTimerSetSize('id', width, height);

Set the size for the display timer.

For rectangular timers it works fully.

For strip - only the width is used (regardless of the verticality of the timer).

void Orion.DisplayTimerSetReversed('id', reversed);

Switch the direction of the timer animation.

void Orion.DisplayTimerSetShowTime('id', reversed);

Show/hide timer counter.

void Orion.DisplayTimerSetIcon('id', 'position', 'iconGraphic', [iconColor='0'], [iconX=0], [iconY=0], [iconWidth=0], [iconHeight=0]) ;

Add an object icon to the timer.

- id - string, timer identifier for further interaction with it;
- position - line, timer position, it can be: Left, Right, Top, Bottom, LeftTop, RightTop, LeftBottom, RightBottom, Custom (displaying the image in the center of the timer);
- iconX and iconY set the timer offset relative to the selected position;
- if a non-zero value is specified for iconWidth or iconHeight - the image resizes to the specified one. Only one value is allowed to change, 0 will be considered as the original size of the width or height.

void Orion.DisplayTimerSetColorStage ('id', percentage, 'textColor', [backgroundColor='0xFFFFFFFF'], [iconColor='0xFFFF'])

Add a state to change the color of the timer when it reaches a certain lifetime (in%). You can add multiple states.

- textColor and iconColor can take the value '0xFFFF', then this field is ignored and the original timer color is used.
- if backgroundColor is specified as '0xFFFFFFFF' - this field is ignored, the original color of the timer is used.

void Orion.BuffTimeRemaining('name');

Checking the remaining buff time by name or Graphic.

Result: time in ms remaining until the end of the effect of the buff, or 0 if there is no buff. If this is buff without the action time return -1.