Fellowship
Information about the character's current fellowship
Fields:
EvenExpSharing boolean
Wether or not this fellowship has even experience sharing
Exists boolean
Check if your character is in a fellowship
IsOpen boolean
Check if a fellowship is open
LeaderId number
The id of the fellowship leader
Locked boolean
Wether or not this fellowship is locked. Locked fellowships do not accept new members.
MAX_FELLOW_COUNT number
Maximum number of fellowship members allowed
Name string
Name of the fellowship
ShareExp boolean
Wether or not this fellowship has experience sharing enabled
Events:
OnLeave EventArgs
Fired when you are no long a part of the fellowship. The fellowship may still exist, you are just no longer a part of it at this point (quit, disbanded, or dismissed).
OnMembersChanged FellowshipChangedEventArgs
Fired when someone other than yourself joins this fellowship.
Methods:
Create(name: string, shareExperience?: boolean = true, options?: ActionOptions = nil, callback?: fun(FellowCreateAction) : nil = nil) : FellowCreateAction
Attempt to create a fellowship.
| Name | Type | Default | Summary |
| name | string | Name of the fellowship | |
| shareExperience | boolean | true | Wether or not to share experience |
| options | ActionOptions | nil | Action options |
| callback | fun(FellowCreateAction) : nil | nil | Called when the action completes |
Disband(options?: ActionOptions = nil, callback?: fun(FellowDisbandAction) : nil = nil) : FellowDisbandAction
Attempt to disband your current fellowship. You must be the leader.
| Name | Type | Default | Summary |
| options | ActionOptions | nil | Action options |
| callback | fun(FellowDisbandAction) : nil | nil | Called when the action completes |
Dismiss(objectId: number, options?: ActionOptions = nil, callback?: fun(FellowDismissAction) : nil = nil) : FellowDismissAction
Attempt to dismiss a member from the fellowship. You must be the leader
| Name | Type | Default | Summary |
| objectId | number | The object id of the member you want to dismiss | |
| options | ActionOptions | nil | Action options |
| callback | fun(FellowDismissAction) : nil | nil | Called when the action completes |
GetPropertyKeys() : string[]
Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts
Quit(disband: boolean, options?: ActionOptions = nil, callback?: fun(FellowQuitAction) : nil = nil) : FellowQuitAction
Attempt to quit your current fellowship.
| Name | Type | Default | Summary |
| disband | boolean | Wether or not to disband the fellowship while quitting. If you specify true you must be the leader | |
| options | ActionOptions | nil | Action options |
| callback | fun(FellowQuitAction) : nil | nil | Called when the action completes |