Collections Orion Assistant

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.AddType('typeName', ['typeValue'=targetRequest]);

Add type or select type (if typeValue isn't suggested).

void Orion.RemoveType('typeName');

Delete type.

void Orion.AddObject('objectName', ['objectValue'=targetRequest]);

Add object or select object (if objectValue isn't suggested)

void Orion.RemoveObject('objectName');

Delete object.

void Orion.AddFindList(['listName'=targetRequest], ['graphic', 'color'], ['comment']);

Add object properties or select to add object properties to Find list.

- listName - list name. If not suggested - target selection appears to add properties to the currently selected element from the list(on the list tab), without auto-save.
- graphic - object type.
- color- object color.
- comment - a comment, which will be displayed in the list.

void Orion.ClearFindList('listName');

Delete search list with all it's content.

- listName - list name.

void Orion.AddIgnoreListObject(['listName'=targetRequest], ['serial'], ['comment']);

Add object to ignore list.

- listName - list name.
- serial - serial of the object..
- comment - a comment, which will be displayed in the list.

void Orion.AddIgnoreList(['listName'=targetRequest], ['graphic', 'color'], ['comment']);

Add object properties or target selection appears to add object properties to the ignore list.

- listName - list name. If not suggested - target selection appears to add properties to the currently selected element from the list(on the list tab), without auto-save
- graphic - Тип объекта.
- color- object color.
- comment - a comment, which will be displayed in the list.

void Orion.ClearIgnoreList('listName');

Delete search list with all it's content.

- listName - list name.

StringList Orion.GetFriendList();

Return string list with friends id's.

StringList Orion.GetEnemyList();

Return string list with enemies id's.

void Orion.AddFriend('friendName', ['serial'=targetRequest]);

Add a friend or select one to add by a target if there's no 'serial' argument.

void Orion.RemoveFriend('serail');

Remove a friend from friends list.

void Orion.ClearFriendList();

Clear friends list.

void Orion.AddEnemy('enemyName', ['serial'=targetRequest]);

Add an enemy or select one to add by a target if there's no 'serial' argument.

void Orion.RemoveEnemy('serial');

Remove an enemy from enemies list.

void Orion.ClearEnemyList();

Clear enemies list.

void Orion.SetGlobal(name, value);

Set a global variable. Value data type is always a string.

String Orion.GetGlobal(name);

Retrieve value ( string data type ) of a global variable

Returns value of the variable or an empty string is no variable is found with such name.

void Orion.ClearGlobals();

Clear global variables list.

Introduced in 3.0.0.0

String Orion.FriendListToString(separator='|');

Unloading the friends list as a string using a separator between separator series.

Result: A string, a list of serial numbers of all friends (example: '0x12345678|0x43526171|0xD163DEF0').

String Orion.EnemyListToString(separator='|');

Unloading the list of enemies as a string using a separator between separator serial numbers.

Result: A string, a list of serial numbers of all enemies (example: '0x12345678|0x43526171|0xD163DEF0').

FindListObject Orion.GetFindList('listName');

Get the FindList object.

Result: An object of type FindListObject, even if the list with the specified name does not exist.

void Orion.UpdateFindList(findListObject);

Save findListObject in the assistant list.

If a list with the same name already exists will overwrite it; if it does not exist, it will create a new one.

IgnoreListObject Orion.GetIgnoreList('listName');

Get the IgnoreList object.

Result: An object of type IgnoreListObject, even if the list with the specified name does not exist.

void Orion.UpdateIgnoreList(ignoreListObject);

Save ignoreListObject in the assistant list.