Shop commands - 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.Buy('shopListName', ['vendorName'], [shopDelay=0]);

Initiate buying.

This will block user input untill completed.

If shops buy list has appeared but there are no matches for buying, this process will end and resume accepting user input.

If shops buy list doesn't appear, it awaits 'shopDelay' amount of time in ms and blocks user input.

  • shopListName - name of the shop list with goods to buy.

  • vendorName - name of vendor.

  • shopDelay - buying operation delay. Will be measured automatically if passed as 0 or as default based on amount of goods to buy and 'Shop delay for 1 stack' value.

void Orion.Sell('shopListName', ['vendorName'], [shopDelay=0]);

Initiate selling.

This will block user input untill completed.

If shops sell list has appeared but there are no matches for selling, this process will end and resume accepting user input.

If shops sell list doesn't appear, it awaits 'shopDelay' amount of time in ms and blocks user input.

  • shopListName - name of the shop list with goods to sell.

  • vendorName - name of vendor.

  • shopDelay - selling operation delay. Will be measured automatically if passed as 0 or as default based on amount of goods to sell and 'Shop delay for 1 stack' value.

Introduced in 2.0.15.0

bool Orion.WaitForShop([delay=1000]);

Await for a shop gump for a given 'delay' amount of time and blocking script execution.

Returns true if a shop gump was received during this period.

Introduced in 3.0.0.0

void Orion.BuyRestock('shopListName', ['vendorName'], [shopDelay=0]);

Proceed to purchase goods to replenish stocks. It only works if Graphic and Color items are specified in the list.

This will block user input untill completed.

If shops buy list has appeared but there are no matches for buying, this process will end and resume accepting user input.

If shops buy list doesn't appear, it awaits 'shopDelay' amount of time in ms and blocks user input.

  • shopListName - name of the shop list with goods to buy.

  • vendorName - name of vendor.

  • shopDelay - buying operation delay. Will be measured automatically if passed as 0 or as default based on amount of goods to buy and 'Shop delay for 1 stack' value.

ShopListObject Orion.GetShopList('listName');

Get object ShopList.

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

void Orion.UpdateShopList(shopListObject);

Save shopListObject 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.

void Orion.BuyHook('shopListName', [shopDelay=0]);

Set hook on buy list.

  • shopListName - name of the shop list with goods to buy.

  • shopDelay - buying operation delay. Will be measured automatically if passed as 0 or as default based on amount of goods to buy and 'Shop delay for 1 stack' value.

void Orion.BuyRestockHook('shopListName', [shopDelay=0]);

Set hook on buy restock list.

  • shopListName - name of the shop list with goods to buy.

  • shopDelay - buying operation delay. Will be measured automatically if passed as 0 or as default based on amount of goods to buy and 'Shop delay for 1 stack' value.

void Orion.SellHook('shopListName', [shopDelay=0]);

Set hook on sell list.

  • shopListName - name of the shop list with goods to buy.

  • shopDelay - buying operation delay. Will be measured automatically if passed as 0 or as default based on amount of goods to buy and 'Shop delay for 1 stack' value.

bool Orion.IsShopping();

Checking whether a purchase or sale is currently underway.

Result: true - if the buy / sell list is being processed now, false if not.