Account groups allow multiple accounts to be specified as a single argument for certain commands. An account group is created with a comma-separated list of names and tokens. (Do not put any spaces in the list.) The list is converted into a group of player and bank accounts (each occurring no more than once), and the command is then applied to all of the accounts. Account groups are not case-sensitive.
Each account group token (with the exception of @none) has a permission node to determine whether a player can use it. Some commands will also prevent attempts to use certain tokens. Be cautious when giving out powerful tokens such as brackets or @players; sketchy administrators could do serious damage to your economy with them in a short period of time.
The types of account group tokens are as follows:
Player: A player. Added by simply entering the full name of the player as the token.
Permission node: BOSEconomy.accountgroup.players
Bank: A bank account. Added by preceding the name of the bank account with a $.
Permission node: BOSEconomy.accountgroup.banks
Bracket: All of the members of a bracket, not including the bracket master. Added by preceding the name of the bracket with a #.
Permission node: BOSEconomy.accountgroup.brackets
All Online Players: All of the currently online players. Added by entering @online as the token.
Permission node: BOSEconomy.accountgroup.general.online
All Offline Players: All of the currently offline players. Added by entering @offline as the token.
Permission node: BOSEconomy.accountgroup.general.offline
All Players: All of the players registered in the economy. Added by entering @players as the token.
Permission node: BOSEconomy.accountgroup.general.players
All Bank Accounts: All of the bank accounts in the economy. Added by entering @banks as the token.
Permission node: BOSEconomy.accountgroup.general.banks
Nobody: Does not add anybody to the account group. This token is meant to be used to construct an empty account group. For example, one might want to create a bank account with some initial members, but no initial owners. Used by entering @none as the token. This token serves no purpose unless it is the only one used in the account group.
Permission node: The token does nothing by itself and therefore does not have a permission node. Added by entering @none as the token.
The following are a few examples of how account groups are used. Consecutive commands are equivalent in function.
Adding a player named Player1 to Bracket1: /econ bracket addmember bracket1 player1 /econ bracket addmember Bracket1 Player1 /econ bracket addmember bRaCkEt1 PLAYER1 (Note that the capitalization of names does not matter.) Adding several players to Bracket1: /econ bracket addmember bracket1 player1,player2,player3 /econ bracket addmember bracket1 player3,player1,player2 /econ bracket addmember bracket1 player1,player2,player3,player2 (Note that Player2 will only be added once, despite appearing twice in the last example.) Removing a bank account Bank1 from Bracket1: /econ bracket removemember bracket1 $bank1 Removing several accounts from Bracket1: /econ bracket removemember bracket1 player1,$bank1,player2,player3,$bank2 Copying all of the accounts in Bracket1 to Bracket2: /econ bracket addmember bracket2 #bracket1 Adding some accounts and all of the members of Bracket1 to Bank1: /econ bank addmember Bank1 player1,$bank2,player2,#bracket1 (Note that Bank2 and any bank accounts present in Bracket1 will be ignored, since only players can be bank account members.) Creating a bank account Bank1 with just some owners: /econ bank create Bank1 player1,player2 /econ bank create Bank1 player1,player2 @none (The syntax for this command allows the second argument to be left entirely blank. This is not always the case for other commands.) Creative a bank account Bank1 with owners and members: /econ bank create Bank1 player1 player2,player3 Creating a bank account Bank1 with just some members: /econ bank create Bank1 @none player1,player2 (If the @none were not provided, the command would add Player1 and Player2 as owners instead.) Adding all online players to Bracket1: /econ bracket addmember bracket1 @online Adding all players to Bracket1: /econ bracket addmember bracket1 @players /econ bracket addmember bracket1 @online,@offline Adding absolutely every account in the economy to Bracket1: /econ bracket addmember bracket1 @players,@banks
If there are problems with the syntax of an account group, it will still attempt to read any accounts it can. The problems it encountered are then displayed alongside the feedback from the command. If the size of your account group resolves to zero for commands which expect at least one valid account, the command will do nothing. Adding spaces to an account group will cause the command to read each space-separated value as an argument and is almost guaranteed to result in failure. A valid account group should never need to use spaces; servers are not supposed to have any accounts or brackets with spaces in their names.
Commands which currently utilize account groups are the following:
- bracket addmember
- bracket removemember
- bracket setmultiplier
- bracket clear
- bank create (players only)
- bank addowner (players only)
- bank addmember (players only)
- bank removemember (players only)