Lua API
On this page
Allegiance
Inherits from
Information about a character's allegiance
Fields:
ChatRoomId number
read only
Allegiance chat room id
Exists boolean
read only
True if your character is in an allegiance
Locked boolean
read only
Wether or not the allegiance is locked
Monarch AllegianceMember
read only
Monarch info
MOTD string
read only
The allegiance message of the day
Name string
read only
The name of the allegiance your character is in
Patron AllegianceMember
read only
Patron info
Rank number
read only
Your allegiance rank
TotalMembers number
read only
Total number of members in this allegiance
TotalVassals number
read only
The number of followers your character has
Vassals AllegianceMember[]
read only
Vassals info
Methods:
Break(options?: ActionOptions = nil, callback?: fun(AllegianceBreakAction) : nil = nil) : AllegianceBreakAction
Break allegiance from your current patron
| Name | Type | Default | Summary |
| options | ActionOptions | nil | Action options |
| callback | fun(AllegianceBreakAction) : nil | nil | Called when the action completes |
Returns:AllegianceBreakAction
GetPropertyKeys() : string[]
Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts
Returns:string[]
SwearTo(objectId: number, options?: ActionOptions = nil, callback?: fun(AllegianceSwearAction) : nil = nil) : AllegianceSwearAction
Swear allegiance to another player
| Name | Type | Default | Summary |
| objectId | number | The object id of the player to swear to | |
| options | ActionOptions | nil | Action options |
| callback | fun(AllegianceSwearAction) : nil | nil | Called when the action completes |
Returns:AllegianceSwearAction
ToString() : string
Returns a string that represents the current object.
Returns:string