Math counter: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Counters use and input/output floating point values, not integers.)
Line 1: Line 1:
{{base point|math_counter|sprite=1}} It stores and manipulates a numerical value. It can trigger on reaching user-defined maximum or minimum values, or output its value every time it changes. It also has the ability to perform simple mathematical functions. When the math_counter is disabled, it will become read-only until re-enabled.
{{base point|math_counter|sprite=1}} It stores and manipulates a numerical value. It can trigger on reaching user-defined maximum or minimum values, or output its value every time it changes. It also has the ability to perform simple mathematical functions. When the math_counter is disabled, it will become read-only until re-enabled.
{{code class|CMathCounter|logicentities.cpp}}
{{clr}}
{{clr}}


Line 8: Line 11:


== Keyvalues ==
== Keyvalues ==
{{KV|Initial Value|integer|Starting value for the counter.}}
{{KV|Initial Value (startvalue)|float|Starting value for the counter.}}
{{KV|Minimum Legal Value|integer|Minimum legal value for the counter. If min{{=}}0 and max{{=}}0, no clamping is performed.}}
{{KV|Minimum Legal Value (min)|float|Minimum legal value for the counter. If min{{=}}0 and max{{=}}0, no clamping is performed.}}
{{KV|Maximum Legal Value|integer|Maximum legal value for the counter. If min{{=}}0 and max{{=}}0, no clamping is performed.}}
{{KV|Maximum Legal Value (max)|float|Maximum legal value for the counter. If min{{=}}0 and max{{=}}0, no clamping is performed.}}
{{KV Targetname}}
{{KV Targetname}}
{{KV EnableDisable}}
{{KV EnableDisable}}


== Inputs ==
== Inputs ==
{{IO|Add|Add an amount to the counter and fire the <code>OutValue</code> output with the result.|param=integer}}
{{IO|Add|Add an amount to the counter and fire the <code>OutValue</code> output with the result.|param=float}}
{{IO|Divide|Divide the counter by an amount and fire the <code>OutValue</code> output with the result.|param=integer}}
{{IO|Divide|Divide the counter by an amount and fire the <code>OutValue</code> output with the result.|param=float}}
{{note|If this causes a division by zero, the counter will ignore the input.}}
{{note|If this causes a division by zero, the counter will ignore the input.}}
{{IO|Multiply|Multiply the counter by an amount and fire the <code>OutValue</code> output with the result.|param=integer}}
{{IO|Multiply|Multiply the counter by an amount and fire the <code>OutValue</code> output with the result.|param=float}}
{{IO|SetValue|Set the counter to a new value and fire the <code>OutValue</code> output with the result.|param=integer}}
{{IO|SetValue|Set the counter to a new value and fire the <code>OutValue</code> output with the result.|param=float}}
{{IO|SetValueNoFire|Set the counter to a new value without firing any outputs.|param=integer}}
{{IO|SetValueNoFire|Set the counter to a new value without firing any outputs.|param=integer}}
{{IO|Subtract|Subtract an amount from the counter and fire the <code>OutValue</code> output with the result.|param=integer}}
{{IO|Subtract|Subtract an amount from the counter and fire the <code>OutValue</code> output with the result.|param=float}}
{{IO|SetHitMax|Set the upper bound of the counter and fire the <code>OutValue</code> output with the current value.|param=integer}}
{{IO|SetHitMax|Set the upper bound of the counter and fire the <code>OutValue</code> output with the current value.|param=float}}
{{IO|SetHitMin|Set the lower bound of the counter and fire the <code>OutValue</code> output with the current value.|param=integer}}
{{IO|SetHitMin|Set the lower bound of the counter and fire the <code>OutValue</code> output with the current value.|param=float}}
{{IO|GetValue|Causes the counter fire its <code>OnGetValue</code> output with the current value of the counter. Used for polling the counter when you don't want constant updates from the <code>OutValue</code> output.}}
{{IO|GetValue|Causes the counter to fire its <code>OnGetValue</code> output with the current value of the counter. Used for polling the counter when you don't want constant updates from the <code>OutValue</code> output.}}
{{IO|SetMaxValueNoFire|Set the MaxValue without firing any outputs.|param=integer|since=P2}}
{{IO|SetMaxValueNoFire|Set the counter to the MaxValue without firing any outputs.|param=float|since=P2}}
{{IO|SetMinValueNoFire|Set the MinValue without firing any outputs.|param=integer|since=P2}}
{{IO|SetMinValueNoFire|Set the counter to the MinValue without firing any outputs.|param=float|since=P2}}
{{I Targetname}}
{{I Targetname}}
{{I EnableDisable}}
{{I EnableDisable}}


== Outputs ==
== Outputs ==
{{IO|OutValue|Fired when the counter value changes.|param=integer}}
{{IO|OutValue|Fired when the counter value changes.|param=float}}
{{note|Generates the value of the [[math_counter]] into the parameters section of an Output Statement. To use a generated parameter, just leave the field reading <none>.}}
{{note|Generates the value of the [[math_counter]] into the parameters section of an Output Statement. To use a generated parameter, just leave the field reading <none>.}}
{{tip|Useful in tandem with [[logic_case]] and [[logic_compare]]}}
{{tip|Useful in tandem with [[logic_case]] and [[logic_compare]]}}
{{IO|OnHitMin|Fired when the counter value meets or goes below the min value. The counter must go back above the min value before the output will fire again.}}
{{IO|OnHitMin|Fired when the counter value meets or goes below the min value. The counter must go back above the min value before the output will fire again.}}
{{IO|OnHitMax|Fired when the counter value meets or exceeds the max value. The counter must go below the max value before the output will fire again.}}
{{IO|OnHitMax|Fired when the counter value meets or exceeds the max value. The counter must go below the max value before the output will fire again.}}
{{IO|OnGetValue|Fired in response to the <code>GetValue</code> input. Used for polling the counter when you don't want constant updates from the <code>OutValue</code> output.|param=integer}}
{{IO|OnGetValue|Fired in response to the <code>GetValue</code> input. Used for polling the counter when you don't want constant updates from the <code>OutValue</code> output.|param=float}}
{{note|Generates the value of the [[math_counter]] into the parameters section of an Output Statement. To use a generated parameter, just leave the field reading <none>.}}
{{note|Generates the value of the [[math_counter]] into the parameters section of an Output Statement. To use a generated parameter, just leave the field reading <none>.}}
{{tip|Useful in tandem with [[logic_case]] and [[logic_compare]]}}
{{tip|Useful in tandem with [[logic_case]], [[math_remap]] and [[logic_compare]].}}
{{IO|OnChangedFromMin|Fired when the counter value changes from the minimum value.|since=AS}}
{{IO|OnChangedFromMin|Fired when the counter value changes from the minimum value.|since=AS}}
{{IO|OnChangedFromMax|Fired when the counter value changes from the max value.|since=AS}}
{{IO|OnChangedFromMax|Fired when the counter value changes from the max value.|since=AS}}
{{O Targetname}}
{{O Targetname}}

Revision as of 01:11, 12 September 2018

Template:Base point It stores and manipulates a numerical value. It can trigger on reaching user-defined maximum or minimum values, or output its value every time it changes. It also has the ability to perform simple mathematical functions. When the math_counter is disabled, it will become read-only until re-enabled.

C++ In code, it is represented by theCMathCounterclass, defined in thelogicentities.cppfile.

See also

Keyvalues

Initial Value (startvalue) ([todo internal name (i)]) <float>
Starting value for the counter.
Minimum Legal Value (min) ([todo internal name (i)]) <float>
Minimum legal value for the counter. If min=0 and max=0, no clamping is performed.
Maximum Legal Value (max) ([todo internal name (i)]) <float>
Maximum legal value for the counter. If min=0 and max=0, no clamping is performed.
Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Inputs

Add <floatRedirectInput/float>
Add an amount to the counter and fire the OutValue output with the result.
Divide <floatRedirectInput/float>
Divide the counter by an amount and fire the OutValue output with the result.
Note.pngNote:If this causes a division by zero, the counter will ignore the input.
Multiply <floatRedirectInput/float>
Multiply the counter by an amount and fire the OutValue output with the result.
SetValue <floatRedirectInput/float>
Set the counter to a new value and fire the OutValue output with the result.
SetValueNoFire <integerRedirectInput/integer>
Set the counter to a new value without firing any outputs.
Subtract <floatRedirectInput/float>
Subtract an amount from the counter and fire the OutValue output with the result.
SetHitMax <floatRedirectInput/float>
Set the upper bound of the counter and fire the OutValue output with the current value.
SetHitMin <floatRedirectInput/float>
Set the lower bound of the counter and fire the OutValue output with the current value.
GetValue
Causes the counter to fire its OnGetValue output with the current value of the counter. Used for polling the counter when you don't want constant updates from the OutValue output.
SetMaxValueNoFire <floatRedirectInput/float> (in all games since Portal 2)
Set the counter to the MaxValue without firing any outputs.
SetMinValueNoFire <floatRedirectInput/float> (in all games since Portal 2)
Set the counter to the MinValue without firing any outputs.

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

OutValue <floatRedirectInput/float>
Fired when the counter value changes.
Note.pngNote:Generates the value of the math_counter into the parameters section of an Output Statement. To use a generated parameter, just leave the field reading <none>.
Tip.pngTip:Useful in tandem with logic_case and logic_compare
OnHitMin
Fired when the counter value meets or goes below the min value. The counter must go back above the min value before the output will fire again.
OnHitMax
Fired when the counter value meets or exceeds the max value. The counter must go below the max value before the output will fire again.
OnGetValue <floatRedirectInput/float>
Fired in response to the GetValue input. Used for polling the counter when you don't want constant updates from the OutValue output.
Note.pngNote:Generates the value of the math_counter into the parameters section of an Output Statement. To use a generated parameter, just leave the field reading <none>.
Tip.pngTip:Useful in tandem with logic_case, math_remap and logic_compare.
OnChangedFromMin  (in all games since Alien Swarm)
Fired when the counter value changes from the minimum value.
OnChangedFromMax  (in all games since Alien Swarm)
Fired when the counter value changes from the max value.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Math_counter&oldid=219200"