Skip to content

guildsetting_placeholders

Jump to bottom
test edited this page Aug 14, 2024 · 7 revisions

This page contains a list of functions that can be used as PLACEHOLDERS and FILTERS

About Arguments

Some functions here may accept an argument. The brackets imply argument type, you do NOT include them when using the function.

  • <arg> - A required parameter
  • [arg] - An optional parameter
  • <arg1|arg2> - Multiple parameters options
  • <arg=value> - Default or suggested value
  • [-f flag] - A optional command argument flag

About Placeholders

Placeholders in a text, such as in a spreadsheet or message, are replaced with actual values.

Examples:

  • {myFunction}
  • {functionWithArgs(123)}
  • {withNamedArgs(myArg: 123 otherArg: 456)}
  • ({conditional}?{ifTrue}:{ifFalse})
  • 9-({numericalFunction}+5)*3

About filters

Filters are used to modify a selection. i.e. When you are choosing which things to act upon or display, you use filters to narrow down the selection to ones that meet a certain requirement. When the return type is a string, the filter can be compared using regex to the value. When the return type is boolean (true/false), it will be resolved to either 1 or 0

Examples:

  • #myBoolean,#myOtherTrueFalseFunction
  • (#myFunction=5||#myOtherFunction<10)
  • #textFunction=abc123,#regexFunction=efg.*
  • (#myFunction<(#myOtherFunction+5)

Operators

  • TERNARY: ?
  • GREATER_EQUAL: >=
  • GREATER: >
  • LESS_EQUAL: <=
  • LESS: <
  • NOT_EQUAL: !=
  • EQUAL: =
  • PLUS: +
  • MINUS: -
  • MULTIPLY: *
  • DIVIDE: /
  • POWER: ^

guildsetting Selectors

  • SETTING: Guild setting name Example: ALLIANCE_ID
  • *: All guild settings

Sheet Columns

A google sheet url with one of the following columns is accepted: setting

Placeholders

#getCategory - GuildSettingCategory

This command is public

The setting category

This command has no arguments

#getCommandMention - String

This command is public

The setting command mention

This command has no arguments

#getKeyName - String

This command is public

The name of the setting type key

This command has no arguments

#getName - String

This command is public

The name of the setting

This command has no arguments

#getResource - double

This command is public

Gets a resource amount from a map of resources

Arguments:

<resources> - Map<ResourceType, Double> A comma separated list of resources and their amounts <resource> - ResourceType The name of a resource

#getResourceValue - double

This command is public

Gets the total resource value for a map of resources

Arguments:

<resources> - Map<ResourceType, Double> A comma separated list of resources and their amounts

#getTypeName - String

This command is public

The simple name of the setting class type

This command has no arguments

#getValue - T

The setting value

Arguments:

[-d checkDelegate] - boolean

Permission:

#getValueString - String

The human readable representation of the value

This command has no arguments

Permission:

#hasInvalidValue - boolean

If the value is invalid

Arguments:

[-d checkDelegate] - boolean

Permission:

#hasValue - boolean

Does the setting have a value (even if invalid)

Arguments:

[-d checkDelegate] - boolean

Permission:

#help - String

This command is public

The setting usage instructions

This command has no arguments

#isChannelType - boolean

This command is public

Is this a channel setting

This command has no arguments

#name - String

This command is public

The setting name

This command has no arguments

#toString - String

This command is public

The setting name and help instructions

This command has no arguments

Clone this wiki locally