Click or drag to resize
GeneralRulesChangeCounter Method
Change a counter's value with a pre-defined operation.

Namespace: (Default Namespace)
Assembly: Default (in Default.exe) Version: 1.0.0.0
Syntax
C#
Copy
public virtual bool ChangeCounter(
	Counter Counter,
	CounterOperation Operation
)

Parameters

Counter
Type: (Default Namespace)Counter
Operation
Type: (Default Namespace)CounterOperation
Specified a pre-defined operation to execute on a counter

Return Value

Type: Boolean
True if the counter value hit a limit, false otherwise. For an operation that stops at a limit, true will only be returned if the counter was unable to change. For an operation that loops, true indicates that the counter looped. For operators that set the counter to a limit, true is returned if the counter was already at the limit value, false otherwise.
Remarks
Counter values can be changed directly with the "=" function, but using a pre-defined operation, you can easily cause the counter to loop when it hits a limit, which is useful for counters linked to tile animations.
See Also