Guild
Functions to handle guild related features.
The constants in this table represent ranks that are used by various functions. They can be mapped to names using the Guild#RankName table
>== Functions ==
allowdepositors
Definition:<br> allowdepositors{int rank, ..} -> string error <br><br> Description: <br> Control who can deposit money into the bank (untested) <br><br> Arguments:<br> rank numbers that represent ranks <br><br> Returns:<br> error error message on failure otherwise nil <br><br> Example:<br> <source lang="lua">Guild.allowdepositors{Guild.RankCommander, Guild.RankCouncil}</source> allow commander and councilmembers to deposit <br><br>
allowlogviewers
Definition:<br> allowlogviewers{int rank, ..} -> string error <br><br> Description: <br> Control who can view the bank transaction log (untested) <br><br> Arguments:<br> rank numbers that represent ranks <br><br> Returns:<br> error error message on failure otherwise nil <br><br> Example:<br> <source lang="lua">Guild.allowlogviewers{Guild.RankCommander, Guild.RankCouncil}</source> allow commander and councilmembers to view the log <br><br>
allowwithdrawalers
Definition:<br> allowwithdrawalers{int rank, ..} -> string error <br><br> Description: <br> Control who can withdraw money from the bank (untested) <br><br> Arguments:<br> rank numbers that represent ranks <br><br> Returns:<br> error error message on failure otherwise nil <br><br> Example:<br> <source lang="lua">Guild.allowwithdrawalers{Guild.RankCommander, Guild.RankCouncil}</source> allow commander and councilmembers to withdraw money <br><br>
appoint
Definition:<br> appoint() -> ? <br><br> Description: <br> appoint a guildmember as lieutenant (untested) <br><br> Arguments:<br> <br><br> Returns:<br> <br><br> Example:<br> <br><br>
create
Definition:<br> create(string acronym, name) -> ? <br><br> Description: <br> create a guild <br><br> Arguments:<br> acronym guild acronym 4 chars or less<br> name name of the guild <br><br> Returns:<br> <br><br> Example:<br> <br><br>
decline
Definition:<br> create(string name) -> ? <br><br> Description: <br> decline an invitation to a guild(untested) <br><br> Arguments:<br> name name of player that invited you <br><br> Returns:<br> <br><br> Example:<br> <br><br>
deposit
Definition:<br> deposit(int amount, string reason) -> boolean valid <br><br> Description: <br> deposit money into the guild bank <br><br> Arguments:<br> amount how much to deposit, can be a number or a string in format accepted by tonumber function eg. '1000' or '1e3'<br> reason reason for deposit or nil <br><br> Returns:<br> valid - true if specified amount was in valid format, else otherwise. (does not depend on whether the operation succeded)<br> information whether money was withdrawn or not is posted to chat via CHAT_MSG_SERVER event. <br><br> Example:<br> <br><br>
expel
Definition:<br> expel(string name) -> ? <br><br> Description: <br> expel a guildmember(untested) <br><br> Arguments:<br> name name of player <br><br> Returns:<br> <br><br> Example:<br> <br><br>
getactivitylogpage
Definition:<br> getactivitylogpage(int page) -> string error <br><br> Description: <br> get activity log page. the function triggers the GUILD_ACTIVITY_LOG event and passes the page to the callback in the registered table. <br><br> Arguments:<br> page page index <br><br> Returns:<br> error error message or nil <br><br> Example:<br> obj = {} function obj:OnEvent(name, data) if print(data) end RegisterEvent(obj, "GUILD_ACTIVITY_LOG") Guild.getactivitylogpage(1) <br><br>
getbankbalance
Definition:<br> getbankbalance() -> ? <br><br> Description: <br> get bank balance(?) triggers GUILD_BALANCE_UPDATED event. with no data though <br><br> Arguments: <br><br> Returns:<br> <br><br> Example:<br> <br><br>
getbanklogpage
Definition:<br> getbanklogpage(int page) -> string error <br><br> Description: <br> get bank log page. the function triggers the GUILD_BANK_LOG event and passes the page to the callback in the registered table. <br><br> Arguments:<br> page page index <br><br> Returns:<br> error error message or nil <br><br> Example:<br> obj = {} function obj:OnEvent(name, data) if print(data) end RegisterEvent(obj, "GUILD_BANK_LOG") Guild.getbanklogpage(1) <br><br>
withdraw
Definition:<br> withdraw(int amount, string reason) -> boolean valid <br><br> Description:<br> Attempts to withdraw specified amount of money from guild bank.
<br> Arguments:<br> amount - amount of money to be withdrawn, can be a number or a string in format accepted by tonumber function eg. '1000' or '1e3'<br> reason <br><br> Returns:<br> valid - true if specified amount was in valid format, else otherwise. (does not depend on whether the operation succeded)<br> information whether money was withdrawn or not is posted to chat via CHAT_MSG_SERVER event. <br><br>
Constants
RankCommander
Value
4
RankCouncil
Value
2
RankCouncilLieutenant
Value
3
RankLieutenant
Value
1
RankMember
Value
0
"getbankprivileges": function: 0xa05f860
"invite": function: 0xa0f8c50
"join": function: 0xa10d650
"list": function: 0xa2e8c50
"motd": function: 0x9e471e0
"resign": function: 0x9ffd898
"setwithdrawallimit": function: 0xa2efab0
"vote": function: 0xa129b38
"RankName": table: 0x9fc6d58
