Guild: Difference between revisions
New page: 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... |
No edit summary |
||
| Line 23: | Line 23: | ||
allow commander and councilmembers to deposit | allow commander and councilmembers to deposit | ||
<br><br> | <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) -> string error | |||
<br><br> | |||
'''Description:''' <br> | |||
deposit money into the guild bank | |||
<br><br> | |||
'''Arguments:'''<br> | |||
'''amount''' how much to deposit<br> | |||
'''reason''' reason for deposit or nil | |||
<br><br> | |||
'''Returns:'''<br> | |||
'''error''' error messsage or nil | |||
<br><br> | |||
'''Example:'''<br> | |||
<br><br> | |||
== Constants == | == Constants == | ||
| Line 47: | Line 155: | ||
"expel": function: 0xa30efa8 | "expel": function: 0xa30efa8 | ||
"getactivitylogpage": function: 0xa225020 | "getactivitylogpage": function: 0xa225020 | ||
Revision as of 00:44, 27 October 2007
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) -> string error
Description:
deposit money into the guild bank
Arguments:
amount how much to deposit
reason reason for deposit or nil
Returns:
error error messsage or nil
Example:
Constants
RankCommander
Value: 4
RankCouncil
Value: 2
RankCouncilLieutenant
Value: 3
RankLieutenant
Value: 1
RankMember
Value: 0
"expel": function: 0xa30efa8 "getactivitylogpage": function: 0xa225020 "getbankbalance": function: 0xa174968 "getbanklogpage": function: 0xa0c3728 "getbankprivileges": function: 0xa05f860 "invite": function: 0xa0f8c50 "join": function: 0xa10d650 "list": function: 0xa2e8c50 "motd": function: 0x9e471e0 "resign": function: 0x9ffd898 "setwithdrawallimit": function: 0xa2efab0 "vote": function: 0xa129b38 "withdraw": function: 0xa08b398 "RankName": table: 0x9fc6d58
