Arguments

AGrantTemplate

The name of a created grant template

No examples provided

---

AGrantTemplate\[Autocomplete\]

No description provided

No examples provided

---

AllianceMetric

A locutus metric for alliances

Options:

• SOLDIER
• SOLDIER_PCT
• TANK
• TANK_PCT
• AIRCRAFT
• AIRCRAFT_PCT
• SHIP
• SHIP_PCT
• INFRA
• INFRA_AVG
• LAND
• LAND_AVG
• SCORE
• SCORE_AVG
• CITY
• CITY_AVG
• MEMBERS
• MEMBERS_ACTIVE_1W
• VM
• INACTIVE_1W
• VM_PCT
• INACTIVE_PCT
• WARCOST_DAILY
• REVENUE
• OFFENSIVE_WARS
• OFFENSIVE_WARS_AVG
• DEFENSIVE_WARS
• DEFENSIVE_WARS_AVG
• REVENUE_MONEY
• REVENUE_FOOD
• REVENUE_COAL
• REVENUE_OIL
• REVENUE_URANIUM
• REVENUE_LEAD
• REVENUE_IRON
• REVENUE_BAUXITE
• REVENUE_GASOLINE
• REVENUE_MUNITIONS
• REVENUE_STEEL
• REVENUE_ALUMINUM
• BARRACKS_PCT
• FACTORY_PCT
• HANGAR_PCT
• DRYDOCK_PCT
• INFRA_VALUE
• LAND_VALUE
• PROJECT_VALUE
• CITY_VALUE
• NUKE
• NUKE_AVG
• MISSILE
• MISSILE_AVG
• GROUND_PCT

---

AllianceMetric\[Autocomplete\]

No description provided

Options:

• SOLDIER
• SOLDIER_PCT
• TANK
• TANK_PCT
• AIRCRAFT
• AIRCRAFT_PCT
• SHIP
• SHIP_PCT
• INFRA
• INFRA_AVG
• LAND
• LAND_AVG
• SCORE
• SCORE_AVG
• CITY
• CITY_AVG
• MEMBERS
• MEMBERS_ACTIVE_1W
• VM
• INACTIVE_1W
• VM_PCT
• INACTIVE_PCT
• WARCOST_DAILY
• REVENUE
• OFFENSIVE_WARS
• OFFENSIVE_WARS_AVG
• DEFENSIVE_WARS
• DEFENSIVE_WARS_AVG
• REVENUE_MONEY
• REVENUE_FOOD
• REVENUE_COAL
• REVENUE_OIL
• REVENUE_URANIUM
• REVENUE_LEAD
• REVENUE_IRON
• REVENUE_BAUXITE
• REVENUE_GASOLINE
• REVENUE_MUNITIONS
• REVENUE_STEEL
• REVENUE_ALUMINUM
• BARRACKS_PCT
• FACTORY_PCT
• HANGAR_PCT
• DRYDOCK_PCT
• INFRA_VALUE
• LAND_VALUE
• PROJECT_VALUE
• CITY_VALUE
• NUKE
• NUKE_AVG
• MISSILE
• MISSILE_AVG
• GROUND_PCT

---

AlliancePermission

In-game permission in an alliance

Options:

• VIEW_BANK
• WITHDRAW_BANK
• CHANGE_PERMISSIONS
• SEE_SPIES
• SEE_RESET_TIMERS
• TAX_BRACKETS
• POST_ANNOUNCEMENTS
• MANAGE_ANNOUNCEMENTS
• ACCEPT_APPLICANTS
• REMOVE_MEMBERS
• EDIT_ALLIANCE_INFO
• MANAGE_TREATIES
• MANAGE_MARKET_SHARE
• MANAGE_EMBARGOES
• PROMOTE_SELF_TO_LEADER

---

AlliancePermission\[Autocomplete\]

No description provided

Options:

• VIEW_BANK
• WITHDRAW_BANK
• CHANGE_PERMISSIONS
• SEE_SPIES
• SEE_RESET_TIMERS
• TAX_BRACKETS
• POST_ANNOUNCEMENTS
• MANAGE_ANNOUNCEMENTS
• ACCEPT_APPLICANTS
• REMOVE_MEMBERS
• EDIT_ALLIANCE_INFO
• MANAGE_TREATIES
• MANAGE_MARKET_SHARE
• MANAGE_EMBARGOES
• PROMOTE_SELF_TO_LEADER

---

AttackType

An attack type

Options:

• GROUND
• VICTORY
• FORTIFY
• Alliance Loot
• Airstrike Infrastructure
• Airstrike Soldiers
• Airstrike Tanks
• Airstrike Money
• Airstrike Ships
• Dogfight
• NAVAL
• PEACE
• MISSILE
• NUKE

---

AuditType

An audit type

Options:

• CHECK_RANK
• INACTIVE
• FINISH_OBJECTIVES
• FIX_COLOR
• CHANGE_CONTINENT
• FIX_WAR_POLICY
• RAID
• UNUSED_MAP
• BARRACKS
• INCORRECT_MMR
• BUY_SOLDIERS
• BUY_HANGARS
• BUY_PLANES
• BUY_SHIPS
• BEIGE_LOOT
• RAID_TURN_CHANGE
• BUY_SPIES
• GATHER_INTEL
• SPY_COMMAND
• LOOT_COMMAND
• DAILY_SPYOPS
• DEPOSIT_RESOURCES
• CHECK_DEPOSITS
• WITHDRAW_DEPOSITS
• OBTAIN_RESOURCES
• SAFEKEEP
• OBTAIN_WARCHEST
• BUY_CITY
• BUY_PROJECT
• BUY_RESOURCE_PRODUCTION_CENTER
• BUY_INFRA
• BUY_LAND
• UNPOWERED
• OVERPOWERED
• NOT_NUCLEAR
• FREE_SLOTS
• NEGATIVE_REVENUE
• MISSING_PRODUCTION_BONUS
• EXCESS_HOSPITAL
• EXCESS_POLICE
• EXCESS_RECYCLING
• GENERATE_CITY_BUILDS
• ROI
• BLOCKADED

---

AutoAuditType\[Autocomplete\]

No description provided

Options:

• GRAY
• HIGH_INFRA
• UNPROFITABLE_FARMS
• UNEVEN_INFRA
• WIND_POWER
• WAR_TYPE_NOT_RAID
• WAR_POLICY
• INACTIVE

---

AutoNickOption

Mode for automatically giving discord nicknames

Options:

• FALSE: No nickname given
• LEADER: Set to leader name
• NATION: Set to nation name
• DISCORD: Set to discord name
• NICKNAME: Set to discord nickname

---

AutoRoleOption

Mode for automatically giving discord roles

Options:

• FALSE: No roles given
• ALL: Alliance roles created for all (see: AUTOROLE_TOP_X)
• ALLIES: Alliance roles created for allies (see: allies coalition)

---

BeigeAlertMode

A mode for receiving alerts when a nation leaves beige

Options:

• NO_ALERTS
• INACTIVE_NONES
• NONES
• NONES_INACTIVE_APPS
• ANYONE_NOT_BLACKLISTED

---

BeigeAlertRequiredStatus

A discord status for receiving alerts when a nation leaves beige

Options:

• ONLINE
• ONLINE_AWAY
• ONLINE_AWAY_DND
• ANY

---

BeigeReason

A reason beiging and defeating an enemy in war

Options:

• VACATION_MODE
• NOT_AN_ENEMY
• INACTIVE
• APPLICANT
• UNDER_C10_SLOG
• OFFENSIVE_WAR
• ALREADY_BEIGE_STACKED
• NO_ENEMY_OFFENSIVE_WARS
• MISSILE_TURRET
• NUKE_TURRET
• NO_RECENT_WARS
• NO_RECENT_3_CONSECUTIVE_LOGINS
• NO_RECENT_5_CONSECUTIVE_LOGINS
• INCORRECT_ENEMY_MMR
• USELESS
• BEIGE_CYCLE
• BEIGE_CYCLE_4D
• BEIGE_CYCLE_1
• BLOCKADED
• LOW_RESISTANCE
• LOW_RESISTANCE_OFFENSIVE
• DO_NOT_RAID
• NO_REASON

---

Boolean

No description provided

Examples:

• true
• false

---

Building

A city building type

No examples provided

---

Category

A discord category name or mention

Examples:

• category-name

---

Category\[Autocomplete\]

No description provided

No examples provided

---

CityBuild

City build json or url

Examples:

• city/id=371923
• {city-json}
• city/id=1{json-modifiers}

---

CityRanges

A range of city counts (inclusive)

Examples:

• c1-10
• c11+

---

CityRanges\[Autocomplete\]

No description provided

No examples provided

---

ClearRolesEnum

Types of users to clear roles of

Options:

• UNUSED: Alliance name roles which have no members
• ALLIANCE: All alliance name roles
• UNREGISTERED: Alliance name roles with no valid in-game alliance

---

ClearRolesEnum\[Autocomplete\]

No description provided

Options:

• UNUSED: Alliance name roles which have no members
• ALLIANCE: All alliance name roles
• UNREGISTERED: Alliance name roles with no valid in-game alliance

---

Coalition

One of the default Locutus coalition names

Options:

• DNR: Alliances to inclide members and applicants in the Do Not Raid list
• DNR_MEMBER: Alliances to include members of in the Do Not Raid list
• CAN_RAID: Alliances to not include in the Do Not Raid list
• FA_FIRST: Alliances to e.g. request peace before countering
• CAN_RAID_INACTIVE: Alliances to not include inactives in the Do Not Raid list
• COUNTER: Alliances to always counter
• IGNORE_FA: Alliances to not ping fa for
• ENEMIES: Enemies
• ALLIES: Allies
• MASKEDALLIANCES: Additional alliances to mask with /role autoassign (if alliance masking is enabled)
• TRADE: ``
• OFFSHORE: Alliances that this guild offshores to
• OFFSHORING: Alliances that offshore to this alliance's bank
• TRACK_DEPOSITS: Alliances to track the deposits of
• UNTRACKED: Dont track war alerts from these alliances
• WHITELISTED: Is whitelisted to use locutus commands (root admin)
• WHITELISTED_AUTO: Auto generated whitelist, any changes will be reverted
• RAIDPERMS: Root coalition- for allowing access to raid tools
• FROZEN_FUNDS: Funds frozen by game admin or by member ban ingame
• GROUND_ALERTS: The coalition to use for alliance ground alerts. See setting: AA_GROUND_UNIT_ALERTS``

---

Coalition\[Autocomplete\]

No description provided

Options:

• DNR: Alliances to inclide members and applicants in the Do Not Raid list
• DNR_MEMBER: Alliances to include members of in the Do Not Raid list
• CAN_RAID: Alliances to not include in the Do Not Raid list
• FA_FIRST: Alliances to e.g. request peace before countering
• CAN_RAID_INACTIVE: Alliances to not include inactives in the Do Not Raid list
• COUNTER: Alliances to always counter
• IGNORE_FA: Alliances to not ping fa for
• ENEMIES: Enemies
• ALLIES: Allies
• MASKEDALLIANCES: Additional alliances to mask with /role autoassign (if alliance masking is enabled)
• TRADE: ``
• OFFSHORE: Alliances that this guild offshores to
• OFFSHORING: Alliances that offshore to this alliance's bank
• TRACK_DEPOSITS: Alliances to track the deposits of
• UNTRACKED: Dont track war alerts from these alliances
• WHITELISTED: Is whitelisted to use locutus commands (root admin)
• WHITELISTED_AUTO: Auto generated whitelist, any changes will be reverted
• RAIDPERMS: Root coalition- for allowing access to raid tools
• FROZEN_FUNDS: Funds frozen by game admin or by member ban ingame
• GROUND_ALERTS: The coalition to use for alliance ground alerts. See setting: AA_GROUND_UNIT_ALERTS``

---

Color

A color name or hex code

Examples:

• #420420

---

Color\[Autocomplete\]

No description provided

No examples provided

---

CommandBehavior

The behavior for a command button

Options:

• DELETE_MESSAGE
• UNPRESS
• DELETE_BUTTONS
• DELETE_PRESSED_BUTTON
• EPHEMERAL

---

CommandCallable

No description provided

No examples provided

---

CommandCallable\[Autocomplete\]

No description provided

No examples provided

---

Continent

Continent name

Options:

• NORTH_AMERICA
• SOUTH_AMERICA
• EUROPE
• AFRICA
• ASIA
• AUSTRALIA
• ANTARCTICA

---

DBAlliance

An alliance name id or url

Examples:

• 'Error 404'
• 7413
• https://politicsandwar.com/alliance/id=7413

---

DBAlliancePosition

An in-game position

No examples provided

---

DBAlliancePosition\[Autocomplete\]

No description provided

No examples provided

---

DBAlliance\[Autocomplete\]

No description provided

No examples provided

---

DBBan

No description provided

No examples provided

---

DBCity

City url

Examples:

• city/id=371923

---

DBLoan\[GuildLoan,Autocomplete\]

No description provided

No examples provided

---

DBLoan\[GuildLoan\]

No description provided

No examples provided

---

DBNation

nation id, name or url

Examples:

• Borg
• <@664156861033086987>
• Danzek
• 189573
• https://politicsandwar.com/nation/id=189573

---

DBNation\[Autocomplete\]

No description provided

No examples provided

---

DBWar

A war id or url

Examples:

• https://politicsandwar.com/nation/war/timeline/war=1234

---

DepositType

A note to use for a bank transfer

Options:

• DEPOSIT
• TAX
• LOAN
• GRANT
• IGNORE
• TRADE
• CITY
• PROJECT
• INFRA
• LAND
• BUILD
• WARCHEST
• RAWS
• EXPIRE

---

DepositTypeInfo

A DepositType optionally with a value and a city tag

Examples:

• #grant #city=1

---

DepositTypeInfo\[Autocomplete\]

No description provided

No examples provided

---

Double

A decimal number

Examples:

• 3.0
• 3*4.5-6/2
• 50.3m

---

EmbeddingSource

The name of an data set

No examples provided

---

EmbeddingSource\[Autocomplete\]

No description provided

No examples provided

---

EnemyAlertChannelMode

An alert mode for the ENEMY_ALERT_CHANNEL when enemies leave beige

Options:

• PING_USERS_IN_RANGE
• PING_ROLE_IN_RANGE
• PING_ROLE_ALL

---

EscrowMode

The mode for escrowing funds for a transfer, such as when a receiver is blockaded

Options:

• NEVER
• WHEN_BLOCKADED
• ALWAYS

---

FlowType

Bank transaction flow type (internal, withdrawal, depost)

Options:

• INTERNAL
• WITHDRAWAL
• DEPOSIT

---

FlowType\[Autocomplete\]

No description provided

Options:

• INTERNAL
• WITHDRAWAL
• DEPOSIT

---

GPTProvider

No description provided

No examples provided

---

GPTProvider\[Autocomplete\]

No description provided

No examples provided

---

Guild

A discord guild id. See: https://en.wikipedia.org/wiki/Template:Discord_server#Getting_Guild_ID

Examples:

• 647252780817448972

---

GuildDB

A discord guild id. See: https://en.wikipedia.org/wiki/Template:Discord_server#Getting_Guild_ID

Examples:

• 647252780817448972

---

GuildSetting

Locutus guild settings

No examples provided

---

GuildSetting\[Autocomplete\]

No description provided

No examples provided

---

Guild\[Autocomplete\]

No description provided

No examples provided

---

ICategorizableChannel

A categorized discord guild channel name or mention

Examples:

• #channel

---

ICommand

A discord slash command reference for the bot

No examples provided

---

ICommand\[Autocomplete\]

No description provided

No examples provided

---

ImageType

An image or captcha type for Optical Character Recognition (OCR)

Options:

• CAPTCHA_NORMAL
• CAPTCHA_INTERFERENCE_LINE
• CAPTCHA_SPOT
• CAPTCHA_WHITE_CHAR
• CAPTCHA_HOLLOW_CHAR
• CLEAR
• NONE
• SCORE
• TEAM
• PLAYER

---

Integer

A whole number

Examples:

• 3
• 3*4-6/2
• 50.3m

---

List<Entry<[String](#String), [String](#String)>>\[Autocomplete\]

No description provided

No examples provided

---

List<Entry<[String](#String), [String](#String)>>\[GuildLoan,Autocomplete\]

No description provided

No examples provided

---

List<Entry<[String](#String), [String](#String)>>\[ReportPerms,Autocomplete\]

No description provided

No examples provided

---

List<[ResourceType](#ResourceType)>

A comma separated list of resource types

Examples:

• aluminum
• money
• *
• manu
• raws
• !food

---

List<[String](#String)>\[Autocomplete\]

No description provided

No examples provided

---

List<[String](#String)>\[Autoparse\]

No description provided

No examples provided

---

List<[String](#String)>\[GuildCoalition,Autocomplete\]

No description provided

No examples provided

---

List<[String](#String)>\[NationAttributeCallable,Autocomplete\]

No description provided

No examples provided

---

List<[String](#String)>\[TextArea\]

Multiple words or text separated by spaces Use quotes for multi-word arguments

Examples:

• a b c

---

Long

A whole number

Examples:

• 3
• 3*4-6/2
• 50.3k

---

Long\[Timediff\]

A time difference or unix timestamp which will resolve as a difference relative to the current date

Examples:

• 5d
• 1w10h3m25s
• timestamp:1682013943000

---

Long\[Timestamp\]

A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date

Examples:

• 5d
• 1w10h3m25s
• dd/MM/yyyy
• timestamp:1682013943000

---

MMRDouble

4 decimal numbers representing barracks, factory, hangar, drydock

Examples:

• 0.0/2.0/5.0/0.0
• 5553

---

MMRDouble\[Autocomplete\]

No description provided

No examples provided

---

MMRInt

4 whole numbers representing barracks,factory,hangar,drydock

Examples:

• 5553
• 0/2/5/0

---

MMRMatcher

An string matching for a nation's military buildings (MMR) In the form 505X where X is any military building

No examples provided

---

MMRMatcher\[Autocomplete\]

No description provided

No examples provided

---

Map<[CityRanges](#CityRanges), Set<[BeigeReason](#BeigeReason)>>

A map of city ranges to a list of beige reasons for defeating an enemy in war Priority is first to last (so put defaults at the bottom)

Examples:

• c1-9:* c10+:INACTIVE,VACATION_MODE,APPLICANT

---

Map<[MilitaryUnit](#MilitaryUnit), [Long](#Long)>

A comma separated list of units and their amounts

Examples:

• {soldiers=12,tanks=56}

---

Map<[NationFilter](#NationFilter), [Integer](#Integer)>

A map of nation filters to tax ids All nation filters are supported (e.g. roles) Priority is first to last (so put defaults at the bottom)

Examples:

• #cities<10:1 #cities>=10:2

---

Map<[NationFilter](#NationFilter), [MMRMatcher](#MMRMatcher)>

A map of nation filters to MMR Use X for any military building All nation filters are supported (e.g. roles) Priority is first to last (so put defaults at the bottom)

Examples:

• #cities<10:505X #cities>=10:0250

---

Map<[NationFilter](#NationFilter), [Role](#Role)>

Auto assign roles based on conditions See: https://github.com/xdnw/locutus/wiki/nation_placeholders Accepts a list of filters to a role. In the form:

#cities<10:@someRole
#cities>=10:@otherRole

Use * as the filter to match all nations. Only alliance members can be given role

No examples provided

---

Map<[NationFilter](#NationFilter), [TaxRate](#TaxRate)>

A map of nation filters to tax rates All nation filters are supported (e.g. roles) Priority is first to last (so put defaults at the bottom)

Examples:

• #cities<10:100/100 #cities>=10:25/25

---

Map<[ResourceType](#ResourceType), [Double](#Double)>

A comma separated list of resources and their amounts

Examples:

• {money=1.2,food=6}
• food 5,money 3
• 5f 3$ 10.5c
• $53
• {food=1}*1.5

---

Map<[ResourceType](#ResourceType), [Double](#Double)>\[AllianceDepositLimit\]

A comma separated list of resources and their amounts, which will be restricted by an alliance's account balance

Examples:

• {money=1.2,food=6}
• food 5,money 3
• 5f 3$ 10.5c
• $53

---

Map<[ResourceType](#ResourceType), [Double](#Double)>\[NationDepositLimit\]

A comma separated list of resources and their amounts, which will be restricted by an nations's account balance

Examples:

• {money=1.2,food=6}
• food 5,money 3
• 5f 3$ 10.5c
• $53

---

Map<[Role](#Role), Set<[Role](#Role)>>

A map of a discord role to a set of roles (comma separated)

Examples:

• @Role1=@Role2,@Role3 @role4=@role5,@role6

---

Map<[String](#String), [String](#String)>

No description provided

No examples provided

---

Member

A discord user mention, or if a nation name, id or url if they are registered

Examples:

• @member
• borg

---

Message

A discord message url

Examples:

• https://discord.com/channels/647252780817448972/973848742769885194/975827690877780050

---

MessageChannel

A discord channel name or mention

Examples:

• #channel

---

MilitaryUnit

Military unit name

Options:

• SOLDIER
• TANK
• AIRCRAFT
• SHIP
• MONEY
• MISSILE
• NUKE
• SPIES
• INFRASTRUCTURE

---

ModelType

A GPT model name

Options:

• GPT_4
• GPT_4_32K
• GPT_3_5_TURBO
• GPT_3_5_TURBO_16K
• TEXT_DAVINCI_003
• TEXT_DAVINCI_002
• TEXT_DAVINCI_001
• TEXT_CURIE_001
• TEXT_BABBAGE_001
• TEXT_ADA_001
• DAVINCI
• CURIE
• BABBAGE
• ADA
• CODE_DAVINCI_002
• CODE_DAVINCI_001
• CODE_CUSHMAN_002
• CODE_CUSHMAN_001
• DAVINCI_CODEX
• CUSHMAN_CODEX
• TEXT_DAVINCI_EDIT_001
• CODE_DAVINCI_EDIT_001
• TEXT_EMBEDDING_ADA_002
• TEXT_SIMILARITY_DAVINCI_001
• TEXT_SIMILARITY_CURIE_001
• TEXT_SIMILARITY_BABBAGE_001
• TEXT_SIMILARITY_ADA_001
• TEXT_SEARCH_DAVINCI_DOC_001
• TEXT_SEARCH_CURIE_DOC_001
• TEXT_SEARCH_BABBAGE_DOC_001
• TEXT_SEARCH_ADA_DOC_001
• CODE_SEARCH_BABBAGE_CODE_001
• CODE_SEARCH_ADA_CODE_001

---

ModelType\[Autocomplete\]

No description provided

Options:

• GPT_4
• GPT_4_32K
• GPT_3_5_TURBO
• GPT_3_5_TURBO_16K
• TEXT_DAVINCI_003
• TEXT_DAVINCI_002
• TEXT_DAVINCI_001
• TEXT_CURIE_001
• TEXT_BABBAGE_001
• TEXT_ADA_001
• DAVINCI
• CURIE
• BABBAGE
• ADA
• CODE_DAVINCI_002
• CODE_DAVINCI_001
• CODE_CUSHMAN_002
• CODE_CUSHMAN_001
• DAVINCI_CODEX
• CUSHMAN_CODEX
• TEXT_DAVINCI_EDIT_001
• CODE_DAVINCI_EDIT_001
• TEXT_EMBEDDING_ADA_002
• TEXT_SIMILARITY_DAVINCI_001
• TEXT_SIMILARITY_CURIE_001
• TEXT_SIMILARITY_BABBAGE_001
• TEXT_SIMILARITY_ADA_001
• TEXT_SEARCH_DAVINCI_DOC_001
• TEXT_SEARCH_CURIE_DOC_001
• TEXT_SEARCH_BABBAGE_DOC_001
• TEXT_SEARCH_ADA_DOC_001
• CODE_SEARCH_BABBAGE_CODE_001
• CODE_SEARCH_ADA_CODE_001

---

NationAttribute

A completed nation attribute that accepts no arguments, returns an object, typically a string, number, boolean or enum To get the attribute for an attribute with arguments, you must provide a value in brackets See: https://github.com/xdnw/locutus/wiki/nation_placeholders

Examples:

• color
• war_policy
• continent
• city(1)

---

NationAttributeDouble

A completed nation attribute that accepts no arguments and returns a number To get the attribute for an attribute with arguments, you must provide a value in brackets See: https://github.com/xdnw/locutus/wiki/nation_placeholders

Examples:

• score
• ships
• land
• getCitiesSince(5d)

---

NationAttributeDouble\[Autocomplete\]

No description provided

No examples provided

---

NationColor

An in-game color bloc

Options:

• AQUA
• BEIGE
• BLACK
• BLUE
• BROWN
• GRAY
• GREEN
• LIME
• MAROON
• OLIVE
• ORANGE
• PINK
• PURPLE
• RED
• WHITE
• YELLOW

---

NationFilter

A comma separated list of filters (can include nations and alliances)

Examples:

• #position>1,#cities<=5

---

NationList

A comma separated list of nations, alliances and filters

Examples:

• borg,AA:Cataclysm,#position>1

---

NationLootType

The reason for a nation's loot being known

Options:

• ESPIONAGE
• WAR_LOSS
• ESTIMATE

---

NationOrAlliance

A nation or alliance name, url or id. Prefix with AA: or nation: to avoid ambiguity if there exists both by the same name or id

Examples:

• Borg
• https://politicsandwar.com/alliance/id=1234
• aa:1234

---

NationOrAllianceOrGuild

A nation or alliance name, url or id, or a guild id

Examples:

• Borg
• alliance/id=7452
• 647252780817448972

---

NationOrAllianceOrGuildOrTaxid

A nation or alliance name, url or id, or a guild id, or a tax id or url

Examples:

• Borg
• alliance/id=7452
• 647252780817448972
• tax_id=1234

---

NationOrAllianceOrGuildOrTaxid\[Autocomplete\]

No description provided

No examples provided

---

NationOrAllianceOrGuild\[Autocomplete\]

No description provided

No examples provided

---

NationOrAlliance\[Autocomplete\]

No description provided

No examples provided

---

NationPlaceholder

See: https://github.com/xdnw/locutus/wiki/nation_placeholders

Examples:

• {nation}

---

NationPlaceholder\[Autocomplete\]

No description provided

No examples provided

---

Number

A decimal number

Examples:

• 3.0
• 3.2*4-6/2
• 50.3k

---

OnlineStatus

A discord user online status

Options:

• ONLINE
• IDLE
• DO_NOT_DISTURB
• INVISIBLE
• OFFLINE
• UNKNOWN

---

OnlineStatus\[Autocomplete\]

No description provided

Options:

• ONLINE
• IDLE
• DO_NOT_DISTURB
• INVISIBLE
• OFFLINE
• UNKNOWN

---

Operation

Math comparison operation

Options:

• LESSER_EQUAL
• GREATER_EQUAL
• NOT_EQUAL
• EQUAL
• GREATER
• LESSER

---

ParametricCallable\[NationAttributeCallable,Autocomplete\]

No description provided

No examples provided

---

ParametricCallable\[NationAttributeCallable\]

The name of a nation attribute See: https://github.com/xdnw/locutus/wiki/nation_placeholders

Examples:

• color
• war_policy
• continent

---

Parser

No description provided

Examples:

• boolean
• String
• Set

---

Parser\[Autocomplete\]

No description provided

No examples provided

---

Permission

A discord role permission

Options:

• MANAGE_CHANNEL
• MANAGE_SERVER
• VIEW_AUDIT_LOGS
• VIEW_CHANNEL
• VIEW_GUILD_INSIGHTS
• MANAGE_ROLES
• MANAGE_PERMISSIONS
• MANAGE_WEBHOOKS
• MANAGE_EMOJIS_AND_STICKERS
• MANAGE_GUILD_EXPRESSIONS
• MANAGE_EVENTS
• VIEW_CREATOR_MONETIZATION_ANALYTICS
• CREATE_INSTANT_INVITE
• KICK_MEMBERS
• BAN_MEMBERS
• NICKNAME_CHANGE
• NICKNAME_MANAGE
• MODERATE_MEMBERS
• MESSAGE_ADD_REACTION
• MESSAGE_SEND
• MESSAGE_TTS
• MESSAGE_MANAGE
• MESSAGE_EMBED_LINKS
• MESSAGE_ATTACH_FILES
• MESSAGE_HISTORY
• MESSAGE_MENTION_EVERYONE
• MESSAGE_EXT_EMOJI
• USE_APPLICATION_COMMANDS
• MESSAGE_EXT_STICKER
• MESSAGE_ATTACH_VOICE_MESSAGE
• MANAGE_THREADS
• CREATE_PUBLIC_THREADS
• CREATE_PRIVATE_THREADS
• MESSAGE_SEND_IN_THREADS
• PRIORITY_SPEAKER
• VOICE_STREAM
• VOICE_CONNECT
• VOICE_SPEAK
• VOICE_MUTE_OTHERS
• VOICE_DEAF_OTHERS
• VOICE_MOVE_OTHERS
• VOICE_USE_VAD
• VOICE_START_ACTIVITIES
• VOICE_USE_SOUNDBOARD
• VOICE_USE_EXTERNAL_SOUNDS
• REQUEST_TO_SPEAK
• ADMINISTRATOR
• UNKNOWN

---

Permission\[Autocomplete\]

No description provided

Options:

• MANAGE_CHANNEL
• MANAGE_SERVER
• VIEW_AUDIT_LOGS
• VIEW_CHANNEL
• VIEW_GUILD_INSIGHTS
• MANAGE_ROLES
• MANAGE_PERMISSIONS
• MANAGE_WEBHOOKS
• MANAGE_EMOJIS_AND_STICKERS
• MANAGE_GUILD_EXPRESSIONS
• MANAGE_EVENTS
• VIEW_CREATOR_MONETIZATION_ANALYTICS
• CREATE_INSTANT_INVITE
• KICK_MEMBERS
• BAN_MEMBERS
• NICKNAME_CHANGE
• NICKNAME_MANAGE
• MODERATE_MEMBERS
• MESSAGE_ADD_REACTION
• MESSAGE_SEND
• MESSAGE_TTS
• MESSAGE_MANAGE
• MESSAGE_EMBED_LINKS
• MESSAGE_ATTACH_FILES
• MESSAGE_HISTORY
• MESSAGE_MENTION_EVERYONE
• MESSAGE_EXT_EMOJI
• USE_APPLICATION_COMMANDS
• MESSAGE_EXT_STICKER
• MESSAGE_ATTACH_VOICE_MESSAGE
• MANAGE_THREADS
• CREATE_PUBLIC_THREADS
• CREATE_PRIVATE_THREADS
• MESSAGE_SEND_IN_THREADS
• PRIORITY_SPEAKER
• VOICE_STREAM
• VOICE_CONNECT
• VOICE_SPEAK
• VOICE_MUTE_OTHERS
• VOICE_DEAF_OTHERS
• VOICE_MOVE_OTHERS
• VOICE_USE_VAD
• VOICE_START_ACTIVITIES
• VOICE_USE_SOUNDBOARD
• VOICE_USE_EXTERNAL_SOUNDS
• REQUEST_TO_SPEAK
• ADMINISTRATOR
• UNKNOWN

---

Project

A project name. Replace spaces with _. See: https://politicsandwar.com/nation/projects/

Examples:

• ACTIVITY_CENTER

---

Project\[Autocomplete\]

No description provided

No examples provided

---

Rank

One of the default in-game position levels

Options:

• leader
• heir
• officer
• member
• applicant
• remove
• ban
• unban
• invite
• uninvite

---

Report

No description provided

No examples provided

---

ReportType

No description provided

Options:

• MULTI
• REROLL
• FRAUD
• BANK_DEFAULT
• COUPING
• THREATS_COERCION
• LEAKING
• DEFAMATION
• SPAMMING
• IMPERSONATING
• PHISHING
• BEHAVIOR_OOC

---

Report\[Autocomplete\]

No description provided

No examples provided

---

Report\[ReportPerms,Autocomplete\]

No description provided

No examples provided

---

Report\[ReportPerms\]

No description provided

No examples provided

---

ResourceType

The name of a resource

Options:

• MONEY
• CREDITS
• FOOD
• COAL
• OIL
• URANIUM
• LEAD
• IRON
• BAUXITE
• GASOLINE
• MUNITIONS
• STEEL
• ALUMINUM

---

Role

A discord role name or mention

Examples:

• @role
• role

---

Role\[Autocomplete\]

No description provided

No examples provided

---

Roles

A discord role name, mention or id

Options:

• REGISTERED: auto role for anyone who is verified with the bot
• MEMBER: Members can run commands
• ADMIN: Admin has access to alliance / guild management commands
• MILCOM: Access to milcom related commands
• MILCOM_NO_PINGS: Access to milcom related commands- doesn't receive pings
• ECON: Has access to econ gov commands
• ECON_STAFF: Has access to economy information commands
• ECON_DEPOSIT_ALERTS: Gets pinged when there is a deposit
• ECON_WITHDRAW_ALERTS: Gets pinged when there is a withdrawal
• ECON_WITHDRAW_SELF: Can withdraw own funds
• ECON_GRANT_SELF: Role to allow member to grant themselves
• FOREIGN_AFFAIRS: Role required to see other alliance's embassy channel
• FOREIGN_AFFAIRS_STAFF: Role for some basic FA commands
• INTERNAL_AFFAIRS: Access to IA related commands
• INTERNAL_AFFAIRS_STAFF: Role for some basic IA commands
• APPLICANT: Applying to join the alliance in-game
• INTERVIEWER: Role to get pinged when a user requests an interview to join the alliance
• MENTOR: Role for mentoring applicants who have completed their interview
• GRADUATED: Members with this role will have their interview channels archived
• RECRUITER: Role to get pinged for recruitment messages (if enabled)
• TRADE_ALERT: Gets pinged for trade alerts
• BEIGE_ALERT: Gets pinged when a nation leaves beige (in their score range), and they have a slot free
• BEIGE_ALERT_OPT_OUT: Overrides the beige alert role
• BOUNTY_ALERT: Gets pings when bounties are placed in their score range
• WAR_ALERT_OPT_OUT: Opt out of received war target alerts
• AUDIT_ALERT_OPT_OUT: Opt out of received audit alerts
• BLITZ_PARTICIPANT: Opt in to blitz participation (clear this regularly)
• BLITZ_PARTICIPANT_OPT_OUT: Opt in to blitz participation (clear this regularly)
• TEMP: Role to signify temporary member, not elligable for grants
• MAIL: Can use mail commands
• BLOCKADED_ALERT: Gets a ping when you are blockaded
• UNBLOCKADED_ALERT: Gets a ping when you are unblockaded
• UNBLOCKADED_GOV_ROLE_ALERT: Pings this role when any member is fully unblockaded
• ESCROW_GOV_ALERT: Pings this role when any member is fully unblockaded and has an escrow balance
• TREASURE_ALERT: Gets alerts in the TREASURE_ALERT_CHANNEL if a treasure is spawning in their range
• TREASURE_ALERT_OPT_OUT: Does not receive treasure alerts (even with the treasure alert role)
• ENEMY_BEIGE_ALERT_AUDITOR: Role to receive pings when an enemy gets beiged
• GROUND_MILITARIZE_ALERT: Role to receive pings when alliances militarize
• AI_COMMAND_ACCESS: Access to AI commands on the discord server

---

Roles\[Autocomplete\]

No description provided

Options:

• REGISTERED: auto role for anyone who is verified with the bot
• MEMBER: Members can run commands
• ADMIN: Admin has access to alliance / guild management commands
• MILCOM: Access to milcom related commands
• MILCOM_NO_PINGS: Access to milcom related commands- doesn't receive pings
• ECON: Has access to econ gov commands
• ECON_STAFF: Has access to economy information commands
• ECON_DEPOSIT_ALERTS: Gets pinged when there is a deposit
• ECON_WITHDRAW_ALERTS: Gets pinged when there is a withdrawal
• ECON_WITHDRAW_SELF: Can withdraw own funds
• ECON_GRANT_SELF: Role to allow member to grant themselves
• FOREIGN_AFFAIRS: Role required to see other alliance's embassy channel
• FOREIGN_AFFAIRS_STAFF: Role for some basic FA commands
• INTERNAL_AFFAIRS: Access to IA related commands
• INTERNAL_AFFAIRS_STAFF: Role for some basic IA commands
• APPLICANT: Applying to join the alliance in-game
• INTERVIEWER: Role to get pinged when a user requests an interview to join the alliance
• MENTOR: Role for mentoring applicants who have completed their interview
• GRADUATED: Members with this role will have their interview channels archived
• RECRUITER: Role to get pinged for recruitment messages (if enabled)
• TRADE_ALERT: Gets pinged for trade alerts
• BEIGE_ALERT: Gets pinged when a nation leaves beige (in their score range), and they have a slot free
• BEIGE_ALERT_OPT_OUT: Overrides the beige alert role
• BOUNTY_ALERT: Gets pings when bounties are placed in their score range
• WAR_ALERT_OPT_OUT: Opt out of received war target alerts
• AUDIT_ALERT_OPT_OUT: Opt out of received audit alerts
• BLITZ_PARTICIPANT: Opt in to blitz participation (clear this regularly)
• BLITZ_PARTICIPANT_OPT_OUT: Opt in to blitz participation (clear this regularly)
• TEMP: Role to signify temporary member, not elligable for grants
• MAIL: Can use mail commands
• BLOCKADED_ALERT: Gets a ping when you are blockaded
• UNBLOCKADED_ALERT: Gets a ping when you are unblockaded
• UNBLOCKADED_GOV_ROLE_ALERT: Pings this role when any member is fully unblockaded
• ESCROW_GOV_ALERT: Pings this role when any member is fully unblockaded and has an escrow balance
• TREASURE_ALERT: Gets alerts in the TREASURE_ALERT_CHANNEL if a treasure is spawning in their range
• TREASURE_ALERT_OPT_OUT: Does not receive treasure alerts (even with the treasure alert role)
• ENEMY_BEIGE_ALERT_AUDITOR: Role to receive pings when an enemy gets beiged
• GROUND_MILITARIZE_ALERT: Role to receive pings when alliances militarize
• AI_COMMAND_ACCESS: Access to AI commands on the discord server

---

Safety

Spy safety level

Options:

• QUICK
• NORMAL
• COVERT

---

Set<[AllianceMetric](#AllianceMetric)>

A comma separated list of alliance metrics

No examples provided

---

Set<[AlliancePermission](#AlliancePermission)>

A comma separated list of In-game permission in an alliance

No examples provided

---

Set<[AttackType](#AttackType)>

A comma separated list of attack types

Examples:

• GROUND,VICTORY

---

Set<[AuditType](#AuditType)>

A comma separated list of audit types

No examples provided

---

Set<[AutoAuditType](#AutoAuditType)>

A comma separated list of auto audit types

No examples provided

---

Set<[BeigeReason](#BeigeReason)>

A comma separated list of beige reasons for defeating an enemy in war

No examples provided

---

Set<[Building](#Building)>

A comma separated list of building types

No examples provided

---

Set<[Category](#Category)>

A comma separated list of discord categories

Examples:

• interview,warcat,public

---

Set<[Continent](#Continent)>

A comma separated list of continents, or *

No examples provided

---

Set<[DBAlliance](#DBAlliance)>

A comma separated list of alliances

Examples:

• Cataclysm,790

---

Set<[DBNation](#DBNation)>

A comma separated list of nations, alliances and filters

Examples:

• borg,AA:Cataclysm,#position>1

---

Set<[EmbeddingSource](#EmbeddingSource)>

A comma separated list of data sets

No examples provided

---

Set<[Integer](#Integer)>

No description provided

Examples:

• 1,2,5

---

Set<[Member](#Member)>

A comma separated list of discord user mentions, or if a nation name, id or url if they are registered

Examples:

• @member1,@member2
• *

---

Set<[MilitaryUnit](#MilitaryUnit)>

A comma separated list of military units

Examples:

• SOLDIER,TANK,AIRCRAFT,SHIP,MISSILE,NUKE

---

Set<[NationAttribute](#NationAttribute)>

A comma separated list of nation attributes

Examples:

• warpolicy,color

---

Set<[NationAttributeDouble](#NationAttributeDouble)>

A comma separated list of numeric nation attributes

Examples:

• score,soldiers

---

Set<[NationOrAlliance](#NationOrAlliance)>

A comma separated list of nations and alliances

Examples:

• borg,AA:Cataclysm

---

Set<[NationOrAllianceOrGuild](#NationOrAllianceOrGuild)>

A comma separated list of nations, alliances and guild ids

Examples:

• borg,AA:Cataclysm,647252780817448972

---

Set<[NationOrAllianceOrGuildOrTaxid](#NationOrAllianceOrGuildOrTaxid)>

A comma separated list of nations, alliances, guild ids and tax ids or urls

Examples:

• borg,AA:Cataclysm,647252780817448972

---

Set<[Operation](#Operation)>

A comma separated list of spy operation types

No examples provided

---

Set<[Project](#Project)>

A comma separated list of alliance projects

No examples provided

---

Set<[ProviderType](#ProviderType)>

A comma separated list of provider types

No examples provided

---

Set<[Role](#Role)>

A comma separated list of discord role names or mentions

Examples:

• @role1,@role2

---

Set<[Roles](#Roles)>

A comma separated list of bot Roles

No examples provided

---

Set<[Status](#Status)>

A comma separated list of the status of a nation's loan

No examples provided

---

Set<[WarStatus](#WarStatus)>

A comma separated list of war statuses

Examples:

• ACTIVE,EXPIRED

---

Set<[WarType](#WarType)>

A comma separated list of war declaration types

Examples:

• ATTRITION,RAID

---

SpreadSheet

A google spreadsheet id or url

Examples:

• sheet:1X2Y3Z4
• https://docs.google.com/spreadsheets/d/1X2Y3Z4/edit#gid=0

---

Status

The status of a nation's loan

Options:

• OPEN
• CLOSED
• EXTENDED
• MISSED_PAYMENT
• DEFAULTED

---

Status\[Autocomplete\]

No description provided

Options:

• OPEN
• CLOSED
• EXTENDED
• MISSED_PAYMENT
• DEFAULTED

---

String

A single line of text

Examples:

• hello

---

String\[Autoparse\]

No description provided

No examples provided

---

String\[GuildCoalition,Autocomplete\]

No description provided

No examples provided

---

String\[GuildCoalition\]

A name for a default or custom Locutus coalition

No examples provided

---

String\[TextArea\]

A single line of text

Examples:

• hello

---

SuccessType

The success type of an attack

Options:

• UTTER_FAILURE
• PYRRHIC_VICTORY
• MODERATE_SUCCESS
• IMMENSE_TRIUMPH

---

TaxBracket

A tax id or url

Examples:

• tax_id=1234
• https://politicsandwar.com/index.php?id=15&tax_id=1234

---

TaxBracket\[Autocomplete\]

No description provided

No examples provided

---

TaxRate

A tax rate in the form of money/rss

Examples:

• 25/25

---

TaxRate\[Autoparse\]

No description provided

No examples provided

---

TemplateTypes

A category for a grant template

Options:

• CITY
• PROJECT
• INFRA
• LAND
• BUILD
• WARCHEST
• RAWS

---

TextChannel

A discord guild channel name or mention

Examples:

• #channel

---

TransferSheet

A google spreadsheet id or url. Must have a nation or leader column as well as the names of each resource

Examples:

• sheet:1X2Y3Z4
• https://docs.google.com/spreadsheets/d/1X2Y3Z4/edit#gid=0

---

Treaty

A treaty between two alliances Link two alliances, separated by a colon

No examples provided

---

TreatyType

An in-game treaty type

Options:

• NONE
• MDP
• MDOAP
• ODP
• ODOAP
• PROTECTORATE
• PIAT
• NAP
• NPT

---

UUID

Universally Unique IDentifier

Examples:

• 8-4-4-4-12

---

UUID\[Autoparse\]

No description provided

No examples provided

---

User

A discord user mention, or if a nation name, id or url if they are registered

Examples:

• @user
• borg

---

WarPolicy

A war policy

Options:

• ATTRITION
• TURTLE
• BLITZKRIEG
• FORTRESS
• MONEYBAGS
• PIRATE
• TACTICIAN
• GUARDIAN
• COVERT
• ARCANE

---

WarStatus

A war status

Options:

• ACTIVE
• DEFENDER_VICTORY
• ATTACKER_VICTORY
• PEACE
• DEFENDER_OFFERED_PEACE
• ATTACKER_OFFERED_PEACE
• EXPIRED

---

WarType

A war declaration type

Options:

• raid
• ordinary
• attrition
• nuclear

---

boolean

No description provided

Examples:

• true
• false

---

double

A decimal number

Examples:

• 3.0
• 3*4.5-6/2
• 50.3m

---

int

A whole number

Examples:

• 3
• 3*4-6/2
• 50.3m

---

long

A whole number

Examples:

• 3
• 3*4-6/2
• 50.3k

---

long\[Timediff\]

A time difference or unix timestamp which will resolve as a difference relative to the current date

Examples:

• 5d
• 1w10h3m25s
• timestamp:1682013943000

---

long\[Timestamp\]

A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date

Examples:

• 5d
• 1w10h3m25s
• dd/MM/yyyy
• timestamp:1682013943000

---

void\[Autoparse\]

No description provided

No examples provided

---