stack
Vars | |
base_state | String. The stack's base icon state. Used when the amount is 2 or lower. |
---|---|
max_icon_state | String. The stack's icon state at the maximum amount. |
plural_icon_state | String. The stack's icon state when amount is greater than 2. |
Procs | |
get_exact_name | Generates a name usable in messages with a specific number attached, i.e. 1 sheet of paper or 5 paper sheets . |
get_stack_name | Returns a string forming a basic name of the stack. By default, this is name . |
get_vague_name | Generates a name usable in messages without a specific number attached, i.e. a sheet of paper or some paper sheets . |
Var Details
base_state
String. The stack's base icon state. Used when the amount is 2 or lower.
max_icon_state
String. The stack's icon state at the maximum amount.
plural_icon_state
String. The stack's icon state when amount is greater than 2.
Proc Details
get_exact_name
Generates a name usable in messages with a specific number attached, i.e. 1 sheet of paper
or 5 paper sheets
.
Parameters:
amount
(Integer, defaultsrc.amount
) - The number of items for the message. Also determines whetherplural_name
orsingular_name
are used.
Returns string.
get_stack_name
Returns a string forming a basic name of the stack. By default, this is name
.
Has no parameters.
get_vague_name
Generates a name usable in messages without a specific number attached, i.e. a sheet of paper
or some paper sheets
.
Parameters:
plural
(Boolean, default(src.amount == 1)
) - Whether the message usesplural_name
orsingular_name
, and the proper grammatical rules.
Returns string.