Skip to content

nationcolor_placeholders

test edited this page Aug 14, 2024 · 8 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: ^

nationcolor Selectors

  • NATIONCOLOR: One of the entity values Example: AQUA, BEIGE, BLACK, BLUE, BROWN, GRAY, GREEN, LIME, MAROON, OLIVE, ORANGE, PINK, PURPLE, RED, WHITE, YELLOW

Sheet Columns

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


Placeholders


#getName - String

This command is public

Get the name of the color.

This command has no arguments


#getNumNations - int

This command is public

Get the number of nations on this color.

Arguments:

[filter] - NationFilter A comma separated list of filters (can include nations and alliances)


#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


#getTurnBonus - int

This command is public

Get the bonus turn income for nations on this color.

This command has no arguments


#getVotedName - String

This command is public

Get the name of the color that was voted by nations.

This command has no arguments


#isTaxable - boolean

This command is public

If this is a taxable color

This command has no arguments


Clone this wiki locally