This article's documentation is for anything that uses the Source engine. Click here for more information.

logic_compare

From Valve Developer Community
Jump to navigation Jump to search
Underlinked - Logo.png
This article needs more Wikipedia icon links to other articles to help Wikipedia icon integrate it into the encyclopedia. Please help improve this article by adding links Wikipedia icon that are relevant to the context within the existing text.
January 2024
English (en)Translate (Translate)
Logic compare.png
Class hierarchy
CLogicCompare
CLogicalEntity
CServerOnlyEntity
CBaseEntity
logicentities.cpp

logic_compare is a point entity available in all Source Source games. It examines the relationship between two numbers ("value" and "compare value"), and fires appropriate output(s).

The equation is (value - compare value).

Keyvalues

Initial value (InitialValue) <integer>
Initial value for the input value.
Compare value (CompareValue) <integer>
The value to compare against.
Name (targetname) <string>
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

Inputs

SetValue <float>
Set the value that will be compared against the compare value.
SetValueCompare <float>
Set the value that will be compared against the compare value and performs the comparison.
Note.pngNote:Some Health based entities like func_physbox. will base its percentage fromm_iMaxHealth when using OnHealthChanged so any change in health will not be accounted for.
SetCompareValue <float>
Set the compare value.
Compare
Force a compare of the input value with the compare value.

Outputs

OnLessThan <float>
Fired when the input value is less than the compare value. Sends the input value as data.
OnEqualTo <float>
Fired when the input value is equal to the compare value. Sends the input value as data.
OnNotEqualTo <float>
Fired when the input value is different from the compare value. Sends the input value as data.
OnGreaterThan <float>
Fired when the input value is greater than the compare value. Sends the input value as data.