Guild: Difference between revisions
No edit summary |
|||
| Line 4: | Line 4: | ||
== Functions == | |||
=== allowdepositors === | === allowdepositors === | ||
'''Definition:''' | '''Definition:'''<br> | ||
allowdepositors{int rank, ..} - | allowdepositors{int rank, ..} -> string error | ||
<br><br> | |||
'''Description:''' | '''Description:''' <br> | ||
Control who can deposit money into the bank (untested) | Control who can deposit money into the bank (untested) | ||
<br><br> | |||
'''Arguments:''' | '''Arguments:'''<br> | ||
'''rank''' numbers that represent ranks | '''rank''' numbers that represent ranks | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
'''error''' error message on failure otherwise nil | '''error''' error message on failure otherwise nil | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
<source lang="lua">Guild.allowdepositors{Guild.RankCommander, Guild.RankCouncil}</source> | |||
allow commander and councilmembers to deposit | allow commander and councilmembers to deposit | ||
<br><br> | |||
=== allowlogviewers === | === allowlogviewers === | ||
'''Definition:''' | '''Definition:'''<br> | ||
allowlogviewers{int rank, ..} - | allowlogviewers{int rank, ..} -> string error | ||
<br><br> | |||
'''Description:''' | '''Description:''' <br> | ||
Control who can view the bank transaction log (untested) | Control who can view the bank transaction log (untested) | ||
<br><br> | |||
'''Arguments:''' | '''Arguments:'''<br> | ||
'''rank''' numbers that represent ranks | '''rank''' numbers that represent ranks | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
'''error''' error message on failure otherwise nil | '''error''' error message on failure otherwise nil | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
<source lang="lua">Guild.allowlogviewers{Guild.RankCommander, Guild.RankCouncil}</source> | |||
allow commander and councilmembers to view the log | allow commander and councilmembers to view the log | ||
<br><br> | |||
=== allowwithdrawalers === | === allowwithdrawalers === | ||
'''Definition:''' | '''Definition:'''<br> | ||
allowwithdrawalers{int rank, ..} - | allowwithdrawalers{int rank, ..} -> string error | ||
<br><br> | |||
'''Description:''' | '''Description:''' <br> | ||
Control who can withdraw money from the bank (untested) | Control who can withdraw money from the bank (untested) | ||
<br><br> | |||
'''Arguments:''' | '''Arguments:'''<br> | ||
'''rank''' numbers that represent ranks | '''rank''' numbers that represent ranks | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
'''error''' error message on failure otherwise nil | '''error''' error message on failure otherwise nil | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
<source lang="lua">Guild.allowwithdrawalers{Guild.RankCommander, Guild.RankCouncil}</source> | |||
allow commander and councilmembers to withdraw money | allow commander and councilmembers to withdraw money | ||
<br><br> | |||
=== appoint === | === appoint === | ||
'''Definition:''' | '''Definition:'''<br> | ||
appoint() - | appoint() -> ? | ||
<br><br> | |||
'''Description:''' | '''Description:''' <br> | ||
appoint a guildmember as lieutenant (untested) | appoint a guildmember as lieutenant (untested) | ||
<br><br> | |||
'''Arguments:''' | '''Arguments:'''<br> | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
<br><br> | |||
=== create === | === create === | ||
'''Definition:''' | '''Definition:'''<br> | ||
create(string acronym, name) - | create(string acronym, name) -> ? | ||
<br><br> | |||
'''Description:''' | '''Description:''' <br> | ||
create a guild | create a guild | ||
<br><br> | |||
'''Arguments:''' | '''Arguments:'''<br> | ||
'''acronym''' guild acronym 4 chars or less | '''acronym''' guild acronym 4 chars or less<br> | ||
'''name''' name of the guild | '''name''' name of the guild | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
<br><br> | |||
=== decline === | === decline === | ||
'''Definition:''' | '''Definition:'''<br> | ||
create(string name) - | create(string name) -> ? | ||
<br><br> | |||
'''Description:''' | '''Description:''' <br> | ||
decline an invitation to a guild(untested) | decline an invitation to a guild(untested) | ||
<br><br> | |||
'''Arguments:''' | '''Arguments:'''<br> | ||
'''name''' name of player that invited you | '''name''' name of player that invited you | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
<br><br> | |||
=== deposit === | === deposit === | ||
'''Definition:''' | '''Definition:'''<br> | ||
deposit(int amount, string reason) - | deposit(int amount, string reason) -> boolean valid | ||
<br><br> | |||
'''Description:''' | '''Description:''' <br> | ||
deposit money into the guild bank | deposit money into the guild bank | ||
<br><br> | |||
'''Arguments:''' | '''Arguments:'''<br> | ||
'''amount''' how much to deposit, can be a number or a string in format accepted by tonumber function eg. '1000' or '1e3' | '''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 | '''reason''' reason for deposit or nil | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
'''valid''' - true if specified amount was in valid format, else otherwise. (does not depend on whether the operation succeded) | '''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. | information whether money was withdrawn or not is posted to chat via CHAT_MSG_SERVER event. | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
<br><br> | |||
=== expel === | === expel === | ||
'''Definition:''' | '''Definition:'''<br> | ||
expel(string name) - | expel(string name) -> ? | ||
<br><br> | |||
'''Description:''' | '''Description:''' <br> | ||
expel a guildmember(untested) | expel a guildmember(untested) | ||
<br><br> | |||
'''Arguments:''' | '''Arguments:'''<br> | ||
'''name''' name of player | '''name''' name of player | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
<br><br> | |||
=== getactivitylogpage === | === getactivitylogpage === | ||
'''Definition:''' | '''Definition:'''<br> | ||
getactivitylogpage(int page) - | getactivitylogpage(int page) -> string error | ||
<br><br> | |||
'''Description:''' | '''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. | 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:''' | '''Arguments:'''<br> | ||
'''page''' page index | '''page''' page index | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
'''error''' error message or nil | '''error''' error message or nil | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
obj = {} function obj:OnEvent(name, data) if print(data) end RegisterEvent(obj, | obj = {} function obj:OnEvent(name, data) if print(data) end RegisterEvent(obj, "GUILD_ACTIVITY_LOG") Guild.getactivitylogpage(1) | ||
<br><br> | |||
| Line 170: | Line 170: | ||
=== getbankbalance === | === getbankbalance === | ||
'''Definition:''' | '''Definition:'''<br> | ||
getbankbalance() - | getbankbalance() -> ? | ||
<br><br> | |||
'''Description:''' | '''Description:''' <br> | ||
get bank balance(?) triggers GUILD_BALANCE_UPDATED event. with no data though | get bank balance(?) triggers GUILD_BALANCE_UPDATED event. with no data though | ||
<br><br> | |||
'''Arguments:''' | '''Arguments:''' | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
<br><br> | |||
=== getbanklogpage === | === getbanklogpage === | ||
'''Definition:''' | '''Definition:'''<br> | ||
getbanklogpage(int page) - | getbanklogpage(int page) -> string error | ||
<br><br> | |||
'''Description:''' | '''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. | 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:''' | '''Arguments:'''<br> | ||
'''page''' page index | '''page''' page index | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
'''error''' error message or nil | '''error''' error message or nil | ||
<br><br> | |||
'''Example:''' | '''Example:'''<br> | ||
obj = {} function obj:OnEvent(name, data) if print(data) end RegisterEvent(obj, | obj = {} function obj:OnEvent(name, data) if print(data) end RegisterEvent(obj, "GUILD_BANK_LOG") Guild.getbanklogpage(1) | ||
<br><br> | |||
=== withdraw === | === withdraw === | ||
'''Definition:''' | '''Definition:'''<br> | ||
withdraw(int amount, string reason) - | withdraw(int amount, string reason) -> boolean valid | ||
<br><br> | |||
'''Description:''' | '''Description:'''<br> | ||
Attempts to withdraw specified amount of money from guild bank. | Attempts to withdraw specified amount of money from guild bank. | ||
<br> | |||
'''Arguments:''' | '''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' | '''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''' | '''reason''' | ||
<br><br> | |||
'''Returns:''' | '''Returns:'''<br> | ||
'''valid''' - true if specified amount was in valid format, else otherwise. (does not depend on whether the operation succeded) | '''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. | information whether money was withdrawn or not is posted to chat via CHAT_MSG_SERVER event. | ||
<br><br> | |||
< | |||
== Constants == | == Constants == | ||
Latest revision as of 18:54, 20 November 2010
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:
allowdepositors{int rank, ..} -> string error
Description:
Control who can deposit money into the bank (untested)
Arguments:
rank numbers that represent ranks
Returns:
error error message on failure otherwise nil
Example:
<source lang="lua">Guild.allowdepositors{Guild.RankCommander, Guild.RankCouncil}</source>
allow commander and councilmembers to deposit
allowlogviewers
Definition:
allowlogviewers{int rank, ..} -> string error
Description:
Control who can view the bank transaction log (untested)
Arguments:
rank numbers that represent ranks
Returns:
error error message on failure otherwise nil
Example:
<source lang="lua">Guild.allowlogviewers{Guild.RankCommander, Guild.RankCouncil}</source>
allow commander and councilmembers to view the log
allowwithdrawalers
Definition:
allowwithdrawalers{int rank, ..} -> string error
Description:
Control who can withdraw money from the bank (untested)
Arguments:
rank numbers that represent ranks
Returns:
error error message on failure otherwise nil
Example:
<source lang="lua">Guild.allowwithdrawalers{Guild.RankCommander, Guild.RankCouncil}</source>
allow commander and councilmembers to withdraw money
appoint
Definition:
appoint() -> ?
Description:
appoint a guildmember as lieutenant (untested)
Arguments:
Returns:
Example:
create
Definition:
create(string acronym, name) -> ?
Description:
create a guild
Arguments:
acronym guild acronym 4 chars or less
name name of the guild
Returns:
Example:
decline
Definition:
create(string name) -> ?
Description:
decline an invitation to a guild(untested)
Arguments:
name name of player that invited you
Returns:
Example:
deposit
Definition:
deposit(int amount, string reason) -> boolean valid
Description:
deposit money into the guild bank
Arguments:
amount how much to deposit, can be a number or a string in format accepted by tonumber function eg. '1000' or '1e3'
reason reason for deposit or nil
Returns:
valid - true if specified amount was in valid format, else otherwise. (does not depend on whether the operation succeded)
information whether money was withdrawn or not is posted to chat via CHAT_MSG_SERVER event.
Example:
expel
Definition:
expel(string name) -> ?
Description:
expel a guildmember(untested)
Arguments:
name name of player
Returns:
Example:
getactivitylogpage
Definition:
getactivitylogpage(int page) -> string error
Description:
get activity log page. the function triggers the GUILD_ACTIVITY_LOG event and passes the page to the callback in the registered table.
Arguments:
page page index
Returns:
error error message or nil
Example:
obj = {} function obj:OnEvent(name, data) if print(data) end RegisterEvent(obj, "GUILD_ACTIVITY_LOG") Guild.getactivitylogpage(1)
getbankbalance
Definition:
getbankbalance() -> ?
Description:
get bank balance(?) triggers GUILD_BALANCE_UPDATED event. with no data though
Arguments:
Returns:
Example:
getbanklogpage
Definition:
getbanklogpage(int page) -> string error
Description:
get bank log page. the function triggers the GUILD_BANK_LOG event and passes the page to the callback in the registered table.
Arguments:
page page index
Returns:
error error message or nil
Example:
obj = {} function obj:OnEvent(name, data) if print(data) end RegisterEvent(obj, "GUILD_BANK_LOG") Guild.getbanklogpage(1)
withdraw
Definition:
withdraw(int amount, string reason) -> boolean valid
Description:
Attempts to withdraw specified amount of money from guild bank.
Arguments:
amount - amount of money to be withdrawn, can be a number or a string in format accepted by tonumber function eg. '1000' or '1e3'
reason
Returns:
valid - true if specified amount was in valid format, else otherwise. (does not depend on whether the operation succeded)
information whether money was withdrawn or not is posted to chat via CHAT_MSG_SERVER event.
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
