Math remap: Difference between revisions

Latest revision as of 07:33, 4 June 2025

Class hierarchy
CMathRemap ↳CLogicalEntity ↳CServerOnlyEntity ↳CBaseEntity
`logicentities.cpp`

math_remap is a logical entity available in all Source games. It remaps a range of input values to a given range of output values.

Flags

Ignore out of range input values : [1]

Clamp output to output range : [2]

Keyvalues

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

Minimum Valid Input Value (in1) <integer>: Input values below this value will be ignored.

Maximum Valid Input Value (in2) <integer>: Input values above this value will be ignored.

Output Value When Input Is Min. (out1) <integer>: When the input value is equal to "Minimum Valid Input Value", this is the output value.

Output Value When Input Is Max. (out2) <integer>: When the input value is equal to "Maximum Valid Input Value", this is the output value.

Note:These do not have to be in order - the math_remap will create an inverse relationship between the input and output if the output keyvalues are swapped.

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

Inputs

InValue <floatRedirectInput/float>: Input value and fire the output with the remapped value.

EnableDisable:

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

Outputs

OutValue <floatRedirectOutput/float>: Fired when the InValue input is received, with the remapped input value as the parameter.

@@ Line 1: / Line 1: @@
-{{wrongtitle|title=math_remap}}
+{{tabs|main=source|source=1|source2=1|math_remap}}
-==Entity Description==
+{{CD|CMathRemap|file1=logicentities.cpp}}
-An entity that remaps a range of input values to a given range of output values.
+{{this is a|logical entity|name=math_remap}} It remaps a range of input values to a given range of output values.
+__NOTOC__
+== Flags ==
+{{fl|1|Ignore out of range input values}}
+{{fl|2|Clamp output to output range}}
-==Keyvalues==
+== Keyvalues ==
-*{{kv targetname}}
+{{KV Targetname}}
-*'''in1''' <integer>
+{{KV|Minimum Valid Input Value|intn=in1|integer|Input values below this value will be ignored.}}
-:Input values below this value will be ignored.
+{{KV|Maximum Valid Input Value|intn=in2|integer|Input values above this value will be ignored.}}
-*'''in2''' <integer>
+{{KV|Output Value When Input Is Min.|intn=out1|integer|When the input value is equal to "Minimum Valid Input Value", this is the output value.}}
-:Input values above this value will be ignored.
+{{KV|Output Value When Input Is Max.|intn=out2|integer|When the input value is equal to "Maximum Valid Input Value", this is the output value.}}
-*'''out1''' <integer>
+{{note|These do not have to be in order - the math_remap will create an inverse relationship between the input and output if the output keyvalues are swapped.}}
-:When the input value is equal to 'Minimum Valid Input Value' ('''in1'''), this is the output value.
+{{KV StartDisabled}}
-*'''out2''' <integer>
-:When the input value is equal to 'Maximum Valid Input Value' ('''in2'''), this is the output value.
-==Flags==
+== Inputs ==
-*1 : Ignore out of range input values
+{{I|InValue|Input value and fire the output with the remapped value.|param=float}}
+{{I EnableDisable}}
-==Inputs==
+== Outputs ==
-*{{i targetname}}
+{{O|OutValue|Fired when the <code>InValue</code> input is received, with the remapped input value as the parameter.|param=float}}
-*'''InValue''' <float>
-:Input value and fire the output with the remapped value.
-==Outputs==
-*{{o targetname}}
-*'''OutValue''' <float>
-:Fired when the '''InValue''' input is received, with the remapped input value as the parameter.
-[[Category:Entities]]