Skip to content

arguments

Jump to bottom
xdnw edited this page Jun 3, 2023 · 2 revisions

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

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

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

Color

A color name or hex code

Examples:

  • #420420

Color[Autocomplete]

No description provided

No examples provided

boolean

No description provided

Examples:

  • true
  • false

Boolean

No description provided

Examples:

  • true
  • false

int

A whole number

Examples:

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

Integer

A whole number

Examples:

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

double

A decimal number

Examples:

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

Double

A decimal number

Examples:

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

List<String>

Multiple words or text separated by spaces

Examples:

  • a b c

List<String>[Autocomplete]

No description provided

No examples provided

List<String>[Autoparse]

No description provided

No examples provided

List<String>[GuildCoalition,Autocomplete]

No description provided

No examples provided

UUID

Universally Unique IDentifier

Examples:

  • 8-4-4-4-12

UUID[Autoparse]

No description provided

No examples provided

String

A single line of text

Examples:

  • hello

String[GuildCoalition]

A name for a default or custom Locutus coalition

No examples provided

String[Autoparse]

No description provided

No examples provided

String[GuildCoalition,Autocomplete]

No description provided

No examples provided

Number

A decimal number

Examples:

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

Set<Integer>

No description provided

Examples:

  • 1,2,5

Set<Member>

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

Examples:

  • @member1,@member2
  • *

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

Message

A discord message url

Examples:

Member

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

Examples:

  • @member
  • borg

CommandCallable

No description provided

No examples provided

CommandCallable[Autocomplete]

No description provided

No examples provided

MessageChannel

A discord channel name or mention

Examples:

  • #channel

User

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

Examples:

  • @user
  • borg

Category

A discord category name or mention

Examples:

  • category-name

Category[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

Guild[Autocomplete]

No description provided

No examples provided

Set<Role>

A comma separated list of discord role names or mentions

Examples:

  • @role1,@role2

Role

A discord role name or mention

Examples:

  • @role
  • role

Role[Autocomplete]

No description provided

No examples provided

TextChannel

A discord guild channel name or mention

Examples:

  • #channel

Set<Roles>

A comma separated list of bot Roles

No examples provided

Map<Role, Set<Role>>

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

Examples:

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

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

ICategorizableChannel

A categorized discord guild channel name or mention

Examples:

  • #channel

SpreadSheet

A google spreadsheet id or url

Examples:

GuildSetting

Bot guild settings

No examples provided

GuildSetting[Autocomplete]

No description provided

No examples provided

Map<MilitaryUnit, Long>

A comma separated list of units and their amounts

Examples:

  • {soldiers=12,tanks=56}

Set<AllianceMetric>

A comma separated list of alliance metrics

No examples provided

DBKingdom

A kingdom name or id

Examples:

  • locutus

DBKingdom[Autocomplete]

No description provided

No examples provided

Set<DBKingdom>

A comma separated list of kingdoms

No examples provided

Set<DBAlliance>

A comma separated list of alliances

No examples provided

Coalition

Coalition class

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
  • MASKED_ALLIANCES: Additional alliances to mask with (if alliance masking is enabled)
  • WHITELISTED: Is whitelisted to use bot commands (root admin)

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
  • MASKED_ALLIANCES: Additional alliances to mask with (if alliance masking is enabled)
  • WHITELISTED: Is whitelisted to use bot commands (root admin)

DBAlliance

An alliance name or id

Examples:

  • paradise

DBAlliance[Autocomplete]

No description provided

No examples provided

Roles

Roles class

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 basic econ commands
  • 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 (this role doesn't grant any elevated permissions)
  • INTERVIEWER: Role to get pinged when a user requests an interview
  • MENTOR: Role to get pinged when a user requests mentoring (can be same as interviewer)
  • GRADUATED: Members with this role will have their interview channels archived
  • RECRUITER: Role to get pinged for recruitment messages (if enabled)
  • ENEMY_ALERT: Gets pinged when a nation leaves alert level (in their score range), and they have a slot free
  • 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
  • MAIL: Can use mail commands

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 basic econ commands
  • 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 (this role doesn't grant any elevated permissions)
  • INTERVIEWER: Role to get pinged when a user requests an interview
  • MENTOR: Role to get pinged when a user requests mentoring (can be same as interviewer)
  • GRADUATED: Members with this role will have their interview channels archived
  • RECRUITER: Role to get pinged for recruitment messages (if enabled)
  • ENEMY_ALERT: Gets pinged when a nation leaves alert level (in their score range), and they have a slot free
  • 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
  • MAIL: Can use mail commands

DBRealm

An realm name or id

Examples:

  • standard

DBRealm[Autocomplete]

No description provided

No examples provided

Set<KingdomAttributeDouble>

A comma separated list of numeric nation attributes

Examples:

  • score,soldiers

EnemyAlertChannelMode

An alert mode for the ENEMY_ALERT_CHANNEL when enemies leave alert levels

Options:

  • PING_STRONGER_USERS_IN_RANGE
  • PING_USERS_IN_RANGE
  • PING_ROLE_IN_RANGE
  • PING_ROLE_ALL

KingdomOrAllianceOrGuild

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

Examples:

  • Borg
  • alliance/id=7452
  • 647252780817448972

KingdomOrAllianceOrGuild[Autocomplete]

No description provided

No examples provided

Set<KingdomOrAllianceOrGuild>

A comma separated list of nations, alliances and guild ids

Examples:

  • borg,AA:Cataclysm,647252780817448972

KingdomAttributeDouble

A numeric nation attribute. See: https://github.com/xdnw/locutus/wiki/Kingdom-Filters

Examples:

  • score
  • ships
  • land

KingdomAttributeDouble[Autocomplete]

No description provided

No examples provided

KingdomAttribute

A nation attribute. See: https://github.com/xdnw/locutus/wiki/Kingdom-Filters

Examples:

  • color
  • war_policy
  • continent

Set<KingdomOrAlliance>

A comma separated list of nations and alliances

Examples:

  • borg,AA:Cataclysm

KingdomOrAlliance

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:

KingdomOrAlliance[Autocomplete]

No description provided

No examples provided

HeroType

Hero class

Options:

  • VISIONARY
  • COMMANDER
  • WARMONGER
  • MOGUL
  • MAGICIAN
  • SLAYER
  • NECROMANCER
  • AUTOMATOR
  • FEY

AutoNickOption

Mode for automatically giving discord nicknames

Options:

  • FALSE: No nickname given
  • KINGDOM: Set to kingomd name
  • DISCORD: Set to discord name

TreatyType

TreatyType class

Options:

  • WAR
  • LAP
  • NAP
  • MDP

Rank

Rank class

Options:

  • NONE
  • APPLICANT
  • MEMBER
  • ADMIN
  • FOUNDER

KingdomPlaceholder

See: https://github.com/xdnw/locutus/wiki/Kingdom-Filters

Examples:

  • {nation}

KingdomPlaceholder[Autocomplete]

No description provided

No examples provided

AutoRoleOption

Mode for automatically giving discord roles

Options:

  • FALSE: No roles given
  • ALL: Roles for the alliance
  • ALLIES: Roles for allies (e.g. if a coalition server)

AttackOrSpellType

AttackOrSpellType types

Options:

  • ATTACK
  • SPY
  • FIREBALL
  • AID

KingdomList

A comma separated list of nations, alliances and filters

Examples:

  • borg,AA:Cataclysm,#position>1

Set<MilitaryUnit>

A comma separated list of MilitaryUnit types

No examples provided

Set<AuditType>

A comma separated list of audit types

No examples provided

Set<AttackOrSpellType>

A comma separated list of AttackOrSpellType types

No examples provided

Set<KingdomAttribute>

A comma separated list of nation attributes

Examples:

  • warpolicy,color

AuditType

audit types

Options:

  • CHECK_RANK
  • INACTIVE

MilitaryUnit

MilitaryUnit types

Options:

  • SOLDIERS
  • CAVALRY
  • ARCHER
  • ELITE
  • GOLD
  • LAND
  • DEVELOPED_LAND
  • MANA
  • EXP
  • BATTLE_POINTS

KingdomFilter

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

Examples:

  • #position>1,#cities<=5

AllianceMetric

A locutus metric for alliances

Options:

  • LAND
  • LAND_AVG
  • MEMBERS
  • MEMBERS_ACTIVE_1W
  • VM
  • INACTIVE_1W
  • VM_PCT
  • INACTIVE_PCT
  • ATTACK
  • ATTACK_AVG
  • DEFENSE
  • DEFENSE_AVG
  • DAILY_STRENGTH_KILLS
  • DAILY_STRENGTH_LOSSES
  • DAILY_STRENGTH_NET
  • DAILY_LAND_GAIN_ABS
  • DAILY_LAND_LOSS_ABS
  • DAILY_LAND_NET
  • LEVEL
  • SPELLS_CAST
  • SPELLS_RECEIVED
  • ATTACKS_DECLARED
  • ATTACKS_RECEIVED
  • SUPPORT_SOLDIERS
  • SUPPORT_GOLD
  • HERO_LEVEL_AVG
  • ALERT_LEVEL_AVG
  • RESOURCE_LEVEL_AVG
  • SPELL_LEVEL_AVG

AllianceMetric[Autocomplete]

No description provided

Options:

  • LAND
  • LAND_AVG
  • MEMBERS
  • MEMBERS_ACTIVE_1W
  • VM
  • INACTIVE_1W
  • VM_PCT
  • INACTIVE_PCT
  • ATTACK
  • ATTACK_AVG
  • DEFENSE
  • DEFENSE_AVG
  • DAILY_STRENGTH_KILLS
  • DAILY_STRENGTH_LOSSES
  • DAILY_STRENGTH_NET
  • DAILY_LAND_GAIN_ABS
  • DAILY_LAND_LOSS_ABS
  • DAILY_LAND_NET
  • LEVEL
  • SPELLS_CAST
  • SPELLS_RECEIVED
  • ATTACKS_DECLARED
  • ATTACKS_RECEIVED
  • SUPPORT_SOLDIERS
  • SUPPORT_GOLD
  • HERO_LEVEL_AVG
  • ALERT_LEVEL_AVG
  • RESOURCE_LEVEL_AVG
  • SPELL_LEVEL_AVG

ClearRolesEnum

Types of users to clear roles of

Options:

  • UNUSED
  • ALLIANCE
  • UNREGISTERED

ClearRolesEnum[Autocomplete]

No description provided

Options:

  • UNUSED
  • ALLIANCE
  • UNREGISTERED

void[Autoparse]

No description provided

No examples provided

List<Entry<String, String>>[Autocomplete]

No description provided

No examples provided

Clone this wiki locally