Skip to content

permissions

Jump to bottom
xdnw edited this page Dec 11, 2023 · 15 revisions

Some commands and placeholders may require certain permissions to use. This page lists the types of permissions used. See each respective command or placeholder page for more details.

Class

Must be used in a guild with a classpath permission set by a bot developer

Arguments:

The class required to execute the command

Coalition

Must be run in a guild added to a coalition by the bot developer

Arguments:

  • value: Coalition | Options: DNR, DNR_MEMBER, CAN_RAID, FA_FIRST, CAN_RAID_INACTIVE, COUNTER, IGNORE_FA, ENEMIES, ALLIES, MASKEDALLIANCES, TRADE, OFFSHORE, OFFSHORING, TRACK_DEPOSITS, UNTRACKED, WHITELISTED, WHITELISTED_AUTO, RAIDPERMS, FROZEN_FUNDS, GROUND_ALERTS

The coalition the guild or alliance must be added to in the Bot Owner's root guild

Deny

HasApi

Must be used in a guild with a valid API_KEY configured

HasKey

Must be run in a guild that has configured the provided settings

Arguments:

A list of guild settings required to be set (default = none)

checkPermission: boolean

HasOffshore

Must be used in a Guild with a valid Locutus managed offshore setup

Arguments:

A list of alliance IDs allowed as the offshore (default = any)

IsAlliance

Must be used in a guild registered to a valid in-game alliance

IsGuild

Must be run in a guild matching the provided ids

Arguments:

A list of guild IDs allowed (default = any)

NotGuild

Cannot be run in guilds matching the provided ids

Arguments:

A list of guild IDs that are denied (default = none)

Rank

Must be registered to a nation with an in-game rank equal to or above the provided rank Default: MEMBER

Arguments:

  • value: Rank | Options: LEADER, HEIR, OFFICER, MEMBER, APPLICANT, REMOVE, BAN, UNBAN, INVITE, UNINVITE

The rank required (default: MEMBER)

Role

Has the aliased roles on discord. any = has any of the roles. root = has role on bot's main guild. guild = has role on that guild. alliance = has role on alliance's guild.

Arguments:

  • value: Roles[] | Options: REGISTERED, MEMBER, ADMIN, MILCOM, MILCOM_NO_PINGS, ECON, ECON_STAFF, ECON_DEPOSIT_ALERTS, ECON_WITHDRAW_ALERTS, ECON_WITHDRAW_SELF, ECON_GRANT_SELF, FOREIGN_AFFAIRS, FOREIGN_AFFAIRS_STAFF, INTERNAL_AFFAIRS, INTERNAL_AFFAIRS_STAFF, APPLICANT, INTERVIEWER, MENTOR, GRADUATED, RECRUITER, TRADE_ALERT, BEIGE_ALERT, BEIGE_ALERT_OPT_OUT, BOUNTY_ALERT, WAR_ALERT_OPT_OUT, AUDIT_ALERT_OPT_OUT, BLITZ_PARTICIPANT, BLITZ_PARTICIPANT_OPT_OUT, TEMP, MAIL, BLOCKADED_ALERT, UNBLOCKADED_ALERT, UNBLOCKADED_GOV_ROLE_ALERT, ESCROW_GOV_ALERT, TREASURE_ALERT, TREASURE_ALERT_OPT_OUT, ENEMY_BEIGE_ALERT_AUDITOR, GROUND_MILITARIZE_ALERT, AI_COMMAND_ACCESS

The roles required to execute the command (all are required unless any = true)

If to use the root guild (not compatible with guild )

Only one of the provided roles are needed to pass

The guild to check roles in (default = same as command)

Whether to allow any alliance specific roles Otherwise only the guild global roles are allowed

Whitelist

Must be run in a guild whitelisted by the bot developer

Clone this wiki locally