Guild

From Vendetta Lua
Revision as of 00:44, 27 October 2007 by Chefkoch (Talk | contribs)

Jump to: navigation, search

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:

Guild.allowdepositors{Guild.RankCommander, Guild.RankCouncil}

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:

Guild.allowlogviewers{Guild.RankCommander, Guild.RankCouncil}

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:

Guild.allowwithdrawalers{Guild.RankCommander, Guild.RankCouncil}

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