Lua API
On this page

ClientActions

classbase
Inherits from
Object

Interface for performing client actions with async callbacks / promises. These actions do thier best to check for validity before sending the action to the server, and throwing specific error messages when something goes wrong.

Methods:

AllegianceBreak(options?: ActionOptions = nil, callback?: fun(AllegianceBreakAction) : nil = nil) : AllegianceBreakAction

Break allegiance from your current patron

Parameters:
NameTypeDefaultSummary
optionsActionOptionsnil

Action options

callbackfun(AllegianceBreakAction) : nil nil

Called when the action completes

AllegianceSwear(objectId: number, options?: ActionOptions = nil, callback?: fun(AllegianceSwearAction) : nil = nil) : AllegianceSwearAction

Swear allegiance to another player

Parameters:
NameTypeDefaultSummary
objectIdnumber

The object id of the player to swear to

optionsActionOptionsnil

Action options

callbackfun(AllegianceSwearAction) : nil nil

Called when the action completes

AttributeAddExperience(attributeId: AttributeId, experienceToSpend: number, options?: ActionOptions = nil, callback?: fun(AttributeAddExperienceAction) : nil = nil) : AttributeAddExperienceAction

Adds experience towards raising an attribute.

Parameters:
NameTypeDefaultSummary
attributeIdAttributeId

The attribute id to spend experience towards

experienceToSpendnumber

The amount of experience to spend

optionsActionOptionsnil

Action options

callbackfun(AttributeAddExperienceAction) : nil nil

Called when the action completes

Blank(options?: ActionOptions = nil, callback?: fun(BlankAction) : nil = nil) : BlankAction

A blank action that always immediately returns success

Parameters:
NameTypeDefaultSummary
optionsActionOptionsnil

Action options

callbackfun(BlankAction) : nil nil

Called when the action completes

Returns:BlankAction

CastEquippedWandSpell(targetId?: number = nil, options?: ActionOptions = nil, callback?: fun(CastEquippedWandSpellAction) : nil = nil) : CastEquippedWandSpellAction

Cast the spell on your current equipped wand, with an optional target.

Parameters:
NameTypeDefaultSummary
targetIdnumber0

The id of the object to target, set to 0 if none.

optionsActionOptionsnil

Action options

callbackfun(CastEquippedWandSpellAction) : nil nil

Called when the action completes

CastSpell(spellId,targetId,options,callback) spellId number , targetId number , options ActionOptions , callback function

FellowCreate(name,shareExperience,options,callback) name string , shareExperience boolean , options ActionOptions , callback function

FellowDisband(options,callback) options ActionOptions , callback function

FellowDismiss(objectId,options,callback) objectId number , options ActionOptions , callback function

FellowQuit(disband,options,callback) disband boolean , options ActionOptions , callback function

FellowRecruit(objectId,options,callback) objectId number , options ActionOptions , callback function

FellowSetLeader(objectId,options,callback) objectId number , options ActionOptions , callback function

FellowSetOpen(open,options,callback) open boolean , options ActionOptions , callback function

GetPropertyKeys(source)

Inscribe(objectId,inscription,options,callback) objectId number , inscription string , options ActionOptions , callback function

InvokeChat(text,options,callback) text string , options ActionOptions , callback function

Login(objectId,options,callback) objectId number , options ActionOptions , callback function

Logout(options,callback) options ActionOptions , callback function

ObjectAppraise(objectId,options,callback) objectId number , options ActionOptions , callback function

ObjectDrop(objectId,options,callback) objectId number , options ActionOptions , callback function

ObjectGive(objectId,targetId,options,callback) objectId number , targetId number , options ActionOptions , callback function

ObjectMove(objectId,targetId,slot,stack,options,callback) objectId number , targetId number , slot number , stack boolean , options ActionOptions , callback function

ObjectSelect(objectId,options,callback) objectId number , options ActionOptions , callback function

ObjectSplit(objectId,targetId,newStackSize,slot,options,callback) objectId number , targetId number , newStackSize number , slot number , options ActionOptions , callback function

ObjectUse(objectId,targetId,options,callback) objectId number , targetId number , options ActionOptions , callback function

ObjectWield(objectId,slot,options,callback) objectId number , slot EquipMask , options ActionOptions , callback function

RunAllOrdered(actions,options,callback) actions QueueAction[] , options ActionOptions , callback function

Salvage(options,callback) options ActionOptions , callback function

SalvageAdd(objectId,options,callback) objectId number , options ActionOptions , callback function

SendTellById(objectId,message,options,callback) objectId number , message string , options ActionOptions , callback function

SetAutorun(enabled,options,callback) enabled boolean , options ActionOptions , callback function

SetCombatMode(combatMode,options,callback) combatMode CombatMode , options ActionOptions , callback function

SkillAddExperience(skillId,experienceToSpend,options,callback) skillId SkillId , experienceToSpend number , options ActionOptions , callback function

SkillAdvance(skill,options,callback) skill SkillId , options ActionOptions , callback function

Sleep(milliseconds,options,callback) milliseconds number , options ActionOptions , callback function

ToString()

TradeAccept(options,callback) options ActionOptions , callback function

TradeAdd(objectId,options,callback) objectId number , options ActionOptions , callback function

TradeDecline(options,callback) options ActionOptions , callback function

TradeEnd(options,callback) options ActionOptions , callback function

TradeReset(options,callback) options ActionOptions , callback function

VendorAddToBuyList(objectId,amount,options,callback) objectId number , amount number , options ActionOptions , callback function

VendorAddToSellList(objectId,options,callback) objectId number , options ActionOptions , callback function

VendorBuyAll(options,callback) options ActionOptions , callback function

VendorClearBuyList(options,callback) options ActionOptions , callback function

VendorClearSellList(options,callback) options ActionOptions , callback function

VendorSellAll(options,callback) options ActionOptions , callback function

VitalAddExperience(vitalId,experienceToSpend,options,callback) vitalId VitalId , experienceToSpend number , options ActionOptions , callback function