Sven Co-op - User contributions [en]

Trigger condition

2023-05-23T21:25:23Z

Loulimi: /* Notes */

{{Entity_Infobox
| title=
}}

A, by default, toggleable entity, which, while activated, will compare any value of any entity's key with either a specified value or the keyvalue of another entity, using a specified comparator and fire its target for the according result - true or false - whenever the result of the condition changes (by default) or at the instant the trigger_condition entity is activated manually. While activated, the trigger_condition checks its condition every 0.1 seconds, by default. Supports [[Mapping/Custom Keyvalues|custom keyvalues]].

== Keyvalues ==

{{Entity_keyvalue|Monitored entity|target|Name of the entity of which a keyvalue is to be monitored. The target entity may be removed in the process. Only one entity by this name should exist.}}
{{Entity_keyvalue|Monitored key|m_iszValueName|Name of the key which's value is to be compared to the value of the compare-key.}}
{{Entity_keyvalue|Compare-entity|m_iszSourceName|Name of the entity of which a keyvalue shall serve as a compare-value. Only one entity by this name should exist.}}
{{Entity_keyvalue|Compare-key|m_iszSourceKey|Name of the key which's value is to be compared to the monitored key.}}
{{Entity_keyvalue|Compare-value (alternative)|m_iszCheckValue|If you do not want to compare the monitored keyvalue to the keyvalue of another entity, you can directly specify a value here. Leave "Compare-entity" empty in that case.}}
{{Entity_keyvalue|Comparator; mon. val. -> comp.-val.|m_iCheckType|Set the comparation type between monitored keyvalue and the other compare value.}}
{{Entity_keyvalue|Target for 'true'-case|netname|Target to trigger in case the condition is true. (Use-type always 'Toggle')}}
{{Entity_keyvalue|Target for 'false'-case|message|Target to trigger in case the condition is false. (Use-type always 'Toggle')}}
{{Entity_keyvalue|Constant mode trigger behaviour|m_iCheckBehaviour|If the trigger_condition uses constant/non-cyclic/toggle-mode, this specifies how it will fire its true- and false-target. The default is to wait for the condition to change in order to trigger a target. You can set it to trigger regardless of the previous result on every interval, or only wait for true-case after a false-case, or only wait false-case after a true-case.}}
{{Entity_keyvalue|Check-interval (seconds)|m_fCheckInterval|If the trigger_condition is toggleable/constant, this specifies the delay between check-intervals, in seconds. Set to 0.0 to check every server-frame. Default is 0.1 seconds.}}

== Flags ==

{{Entity_flag|1|Start off|The trigger_condition starts off and has to be triggered on manually in order to work; this is automatically the case when it is cyclic.}}
{{Entity_flag|2|Don't use X (R)|When using vectors/arrays, this will ignore the first array.}}
{{Entity_flag|4|Don't use Y (G)|When using vectors/arrays, this will ignore the second array.}}
{{Entity_flag|8|Don't use Z (B)|When using vectors/arrays, this will ignore the third array.}}
{{Entity_flag|16|Don't use W (A)|When using vectors/arrays, this will ignore the fourth array.}}
{{Entity_flag|32|Cyclic; no toggle|Changes the trigger_condition's behaviour to a single-fire-behaviour. With this flag set, the entity will fire a target according to its condition's result once, and then idle until triggered again.}}
{{Entity_flag|64|Keep '!activator'|Because of trigger_condition's default behavior, the reference to the original activator is overwritten with the trigger_condition itself, because of an expected delay between activating the trigger_condition and a change in its condition's result; within this delay the original activator could have been removed already and thus cause unwanted behaviour when used. Because of that, you have to explicitly enable this flag for the activator to be forwarded normally. This is only dangerous to use if an entity triggered by trigger_condition will expect the activator to refer to a valid entity.}}
{{Entity_flag|128|Ignore initial result|If this is set and this trigger_condition is not set to be cyclic, every time you activate it, the very first result it produces will be ignored and nothing will be triggered, and it will proceed normal according to the specified trigger-behaviour.}}

== Notes ==

Trigger_condition supports the use of "!activator" and "!caller" in the "Monitored entity"- and "Compare-entity"-fields.

The type of comparison can depend on the types of the monitored keyvalue and comparison keyvalue. E.g. comparing a string "0 0 0" from monitored keyvalue to a vector { 0.0 0.0 0.0 } will cause the vector to be transformed into the string "0.000000 0.000000 0.000000". The string "0 0 0" is not equal to the string "0.000000 0.000000 0.000000". However, comparing a vector { 0.0 0.0 0.0 } from monitored keyvalue to a string "0 0 0" will cause the string to be parsed into another vector { 0.0 0.0 0.0 } which then is equal to the vector in the monitored keyvalue.Comparing a vector to an integer or float will cause the length of that vector to be compared. (This works either way round) This happens in regards to the vector-dimension-exclusion keyvalues. Exception: If you exclude exactly two of the three vector-dimensions, you will get the extents of the vector in the one non-excluded dimension. That means if that extent is negative, you will also get it as negative.Comparing vectors with each other will cause their lengths to be compared, unless comparison-type is "Equal" or "Unequal". Should that not be what you want, you'd have to parse the single extents into floats and compare them one by one for the time being.

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Game counter

2023-05-23T21:14:09Z

Loulimi: Add more details regarding the frags keyvalue

{{Entity_Infobox
| title=
}}

This is a logic entity which will fire its target after being triggered a specified amount of times. Toggle-trigger and on-trigger will cause it to count up by 1. Off-trigger will cause it to count down by 1. An equivalent of this entity can be created through the usage of trigger_condition and trigger_changevalue.

It is also possible to access the number of times this entity was triggered.

== Keyvalues ==

{{Entity_keyvalue|Initial value|frags|Starting value of entity. It's also its current value when accessing it through other entities like trigger_copyvalue or trigger_condition.}}
{{Entity_keyvalue|Limit value|health|Required value to trigger target.}}

== Flags ==

{{Entity_flag|1|Remove On fire|Remove entity after firing.}}
{{Entity_flag|2|Reset On fire|Reset entity Initial value after fired.}}
{{Entity_flag|4|Fire if over limit|Fire a target when initial value is higher than limit value.}}

== Notes ==

The game_counter’s current count can be accessed from the "frags" keyvalue.

== Issues ==

When target is set to ambient_generic, the game_counter need to receive twice more inputs than normal, unless "Fire if over limit" spawnflag is selected.

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Trigger changevalue

2023-05-23T21:04:50Z

Loulimi: /* Notes */ Add note about multiple targets.

{{Entity_Infobox
| title=
}}

Trigger_changevalue can perform arithmetic and logic operations on base-keyvalues of entities, as well as replace their private keyvalues. See [[trigger_copyvalue]] for a variant of this with more options. Supports custom keyvalues.

== Keyvalues ==

{{Entity_keyvalue|Destination Entity|target|Name of the entity which's keyvalue is to changed. This can refer to more than one.}}
{{Entity_keyvalue|Destination Keyvalue|m_iszValueName|Name of the key which's value is to be changed.}}
{{Entity_keyvalue|Static source-value|m_iszNewValue|Value to be applied to the destination keyvalue.}}
{{Entity_keyvalue|Operation|m_iszValueType|This specifies how destination keyvalue and static source-value correlate. What exactly happens also depends on the types
of the two. There are some academic things in here, so I shall explain some of them:Pow: Source value to the power of destination value. To keep things simple, zero to the power of zero magically equals one and taking a negative value to the power of a non-integer will cause the base to be treated as positive.Mod: Short for "Modulo", this calculates the rest of a division. For example, 63 % 13 equals 11, because 63 - 13 = 50, 50 - 13 = 37, 37 - 13 = 24 and 24 - 13 = 11. Substracting a fifth time would deliver a negative result and is henceforth omitted. The actual computation of this value uses a smarter, fast method; this is just for presentiveness. Usage example: You have a value in seconds, e.g. 285, and want to know how many minutes and seconds that are, so you divide by 60 and get 4.75. Omitting the 0.75 you're left with 4. For the remaining seconds, you'd calculate 285 % 60 = 45, which
is the same as 60 * 0.75. Then you'd know that 285 seconds equals 4 minutes plus 45 seconds. Real numbers and negative values are supported.AND, OR, XOR, NAND, NOR, NXOR: These are logic operands which operate bitwise; the leading 'N' indicates bitwise negation after the operation. Example: An entity's spawnflags are stored in an integer which consists of 32 bits. Say you want to set the 7th checkbox of an entity's spawnflags, you need to make sure the 7th bit is set to 1. You hence need the integer number where only the 7th bit is set, which is 2 ^ (7 - 1) = 2 ^ 6 = 64. However, you cannot simply add this
to the existing spawnflags, because if the 7th bit was already set to 1, you'd cause it to be set to 0 and generate a carry which is sent to the 8th bit; the magic of positional notation systems - just as 500 + 500 equals 1000 in decimal, 100 + 100 equals 1000 in binary. You'd need to perform a bitwise OR. If you'd want only the 7th checkbox to be checked, you'd use replace-operation as usual. XOR means "Exclusive OR", as in "Either that or the other, but not both". AND means that both bits need to be 1 for the resulting bit to remain 1. You can imagine the logic operators perform 32 simultaneous operations on the combined 64 bits of two integers. Append (String concatenation): Appends your source value to the destination keyvalue. The later must be a string; otherwise this cannot work.}}
{{Entity_keyvalue|Trigonometric funcs. I/O|m_trigonometricBehaviour|When using trigonometric or arc-functions as per the "Operation"-keyvalue, this is used to determine what your input/desired output measure is. You'll usually want to stick to degrees.}}
{{Entity_keyvalue|Append spaces (for strings)|m_iAppendSpaces|When the destination keyvalue is a string, this specifies how many spaces to append after the operations. You'll usually want to use this with either the "Replace"- or "Append"-operation. This was implemented because Valve Hammer Editor omits any trailing spaces in keyvalues (but not leading ones).}}
{{Entity_keyvalue|Trigger after operation|message|Set entity/entities to be triggered after the trigger_changevalue has set the new keyvalue, by targetname as usual.
This is very useful when you need a chain of operations to happen in a specific order and without any delay in between.}}

== Flags ==

{{Entity_flag|1|Don't use X|When using vectors/arrays, this will ignore the first array. E.g., when setting render-color, specifying this flag would ignore the 'Red'-value.}}
{{Entity_flag|2|Don't use Y|When using vectors/arrays, this will ignore the second array. E.g., when setting angles, specifying this flag would ignore the 'Yaw'-value.}}
{{Entity_flag|4|Don't use Z|When using vectors/arrays, this will ignore the third array. E.g., when setting velocity, specifying this flag would ignore the vertical velocity.}}
{{Entity_flag|32|Invert target value|The destination keyvalue will be multiplied with minus one before proceeding.}}
{{Entity_flag|64|Invert source value|The source-value will be multiplied with minus one before proceeding; this change is only temporary and this keyvalue is rather useless, as you can always prepend a minus-sign to the static source-value.}}

== Notes ==

Trigger_changevalue supports the use of "!activator" and "!caller" in the "Destination Entity" field.

Trying to write a vector to a float or integer will cause the vector's length to be written. This is in respect to any ignored dimensions as per spawnflags.

Unlike trigger_changetarget, trigger_changevalue can update multiple entities at the same time if they share the same name.

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Game player counter

2023-05-23T21:02:50Z

Loulimi: Add way around bug

{{Entity_Infobox
| title=
}}

This entity automatically fires its targets based on the number of players connected to the server. It will automatically fire its "Min Target" when "Min Value" is reached and its "Max Target" when "Max Value" is reached.
This entity is partially broken, it doesn’t work correctly after a level change for instance, and you cannot access the current number of connected players with it.

== Keyvalues ==

{{Entity_keyvalue|Min Value|frags|Player-count for "Min Target".}}
{{Entity_keyvalue|Max Value|health|Player-count for "Max Target".}}
{{Entity_keyvalue|Min Target|target|Target to trigger when "Min Value" is reached.}}
{{Entity_keyvalue|Max Target|netname|Target to trigger when "Max Value" is reached.}}
{{Entity_keyvalue|Filter Player Targetname|message|If set, only players by that targetname will cause the game_player_counter to count up/down. It's not possible to set a targetname on a player before he connects, so don't ask me how to make use of this.}}

== Notes ==

This entity is partially broken, it doesn’t work correctly after a level change for instance, and you cannot access the current number of connected players with it. You can instead replace this entity’s behaviour with a trigger_entity_iterator and a game_counter.
Unlike other entities, game_player_counter sends 'On' output instead of 'Toggle'.

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Trigger changetarget

2023-05-23T21:00:48Z

Loulimi: Add note regarding behaviour with multiple entities sharing the same name

{{Entity_Infobox
| title=
}}

This entity changes the target keyvalue of an entity. You should generally prefer this to using a trigger_changevalue, if you can, because this entity takes several special cases into account. Be aware however that this entity only work correctly with entities that have a unique name, see note for more details.

== Keyvalues ==

{{Entity_keyvalue|Target|target|Entity whose target will be changed.}}
{{Entity_keyvalue|New Target|m_iszNewTarget|New "Target" value for targeted entity.}}

== Notes ==

This entity can only update one entity’s target. If multiple entities share the same name, and that name is specified as the trigger_changetarget’s target, only one of those entities will have its target updated.

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Game player counter

2023-05-23T20:44:07Z

Loulimi: Add warning concerning bug of entity

{{Entity_Infobox
| title=
}}

This entity automatically fires its targets based on the number of players connected to the server. It will automatically fire its "Min Target" when "Min Value" is reached and its "Max Target" when "Max Value" is reached.
This entity is partially broken, it doesn’t work correctly after a level change for instance, and you cannot access the current number of connected players with it.

== Keyvalues ==

{{Entity_keyvalue|Min Value|frags|Player-count for "Min Target".}}
{{Entity_keyvalue|Max Value|health|Player-count for "Max Target".}}
{{Entity_keyvalue|Min Target|target|Target to trigger when "Min Value" is reached.}}
{{Entity_keyvalue|Max Target|netname|Target to trigger when "Max Value" is reached.}}
{{Entity_keyvalue|Filter Player Targetname|message|If set, only players by that targetname will cause the game_player_counter to count up/down. It's not possible to set a targetname on a player before he connects, so don't ask me how to make use of this.}}

== Notes ==

Unlike other entities, game_player_counter sends 'On' output instead of 'Toggle'. This entity is partially broken, it doesn’t work correctly after a level change for instance, and you cannot access the current number of connected players with it.

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Trigger changetarget

2023-05-15T13:52:06Z

Loulimi: Fix grammatical mistakes

{{Entity_Infobox
| title=
}}

The proper method for changing the target-keyvalue of an entity. You should prefer this to using a trigger_changevalue, if you can, because this entity takes several special cases into account.

== Keyvalues ==

{{Entity_keyvalue|Target|target|Entity whose target will be changed.}}
{{Entity_keyvalue|New Target|m_iszNewTarget|New "Target" value for targeted entity.}}

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Func button

2023-05-01T12:25:01Z

Loulimi: Add more details about "Lip" and "Delay before reset"

{{Entity_Infobox
| title=
| type=b
}}

A brush entity, which can be triggered by the player by issuing his 'Use'-command on it while standing next to it and looking at it. The
func_button then triggers its target. This is the most common entity for players interacting with other map entities or entity systems.

== Keyvalues ==

{{Entity_keyvalue|Target|target|The func_button triggers its target when used or triggered by another entity. You can add 'killtarget' manually.}}
{{Entity_keyvalue|Locked Sound|locked_sound|Sound to play if the button is pressed while locked.}}
{{Entity_keyvalue|Unlocked Sound|unlocked_sound|Sound to play if the button is pressed while not locked.}}
{{Entity_keyvalue|Locked Sentence|locked_sentence|Sentence to be heard if the button is pressed while locked. It is spoken with the voice of Half-Life's Black Mesa announcer.}}
{{Entity_keyvalue|Unlocked Sentence|unlocked_sentence|Sentence to be heard if the button is pressed while not locked. It is spoken with the voice of Half-Life's Black Mesa announcer.}}
{{Entity_keyvalue|Speed|speed|Speed at which the button moves when pressed, unless 'Don't move' is set. The button moves for its width in the move direction, specified by 'angle'.}}
{{Entity_keyvalue|Health (shootable if >0)|health|If you enter here value higher than 0, the button becomes shootable only, and can be activated when it's out of health. }}
{{Entity_keyvalue|Lip|lip|This value will be deducted from the buttons move distance. Negative values are allowed. It is blank by default.}}
{{Entity_keyvalue|Master|master|Allows you to specify the name of a multisource entity to lock/unlock this button.}}
{{Entity_keyvalue|Sounds|sounds|Set the sound to be played when the button is pressed. It will play when the button is locked, too.}}
{{Entity_keyvalue|Delay before reset|wait|When the button is pressed, it will remain in its pressed state for this amount of time. This also affects any toggleable textures on it. If set to '-1', the button can be pressed only once, and will then remain in its pressed state forever, even with the "Toggle" flag checked.
* If the "Toggle" flag is checked, you must specify a value equal to or greater than 0.
* If a multisource entity is among the func_button's targets, that multisource entity will recognize the button's input to be active only for this amount of time. }}
{{Entity_keyvalue|Classification|classify|Classification of this button. If specified, enemies of this class will attack this button.}}
{{Entity_keyvalue|Locked Sound Override|locked_sound_override|Sound file to use when attempting to open locked entity. Useful when you don't want to use sound from default sound list.

This overrides default "Locked Sound" sound.}}
{{Entity_keyvalue|Unlocked Sound Override|unlocked_sound_override|Sound file to use when entity is unlocked. Useful when you don't want to use sound from default sound list.

This overrides default "Locked Sound" sound.}}
{{Entity_keyvalue|Locked Sentence Override|locked_sentence_override|Sentence from sentences.txt to use when attempting to open locked entity. Useful when you want to override locked sentence with your own sentence.}}
{{Entity_keyvalue|Unlocked Sentence Override|unlocked_sentence_override|Sentence from sentences.txt to use when entity is unlocked. Useful when you want to override unlocked sentence with your own sentence.}}
{{Entity_keyvalue|Sound Override|noise|Custom sound, that overrides default sound from "Sounds" list to play when the button is pressed. It will play when the button is locked, too.

Inventory Rules, InventoryRules @BaseClass:
List of inventory-related keyvalues used with item_inventory entity. Whenever player is attempting to use an entity, the inventory test runs. If test result is negative, the entity won't work. In other case, entity can be used as normal, but only by player who passed the test with required inventory conditions:"Inventory: Need item(s)", item_name_required : Item(s) (names separated by spaces) required to use this entity.
Refers to "Item name" value of item_inventory.}}
{{Entity_keyvalue|Inventory: Need item(s) from group(s)|item_group_required|Groups (separated by spaces), in which carried items belong to, required to use this entity. Refers to "Item group name" value of item_inventory.}}
{{Entity_keyvalue|Inventory: Item count in group need have|item_group_required_num|Minimal number of items, that belong
to specified group, required to use this entity. Use with "Inventory: Need item(s) from group(s)" keyvalue. Value of '0' means that all items from current group are required.}}
{{Entity_keyvalue|Inventory: CAN'T have item|item_name_canthave|Items in player inventory that will fail the test, and disallow usage
of this entity. Refers to "Item name" value of item_inventory.}}
{{Entity_keyvalue|Inventory: CAN'T have item from group|item_group_canthave|Items in player inventory, which belong to specified group, that will fail the test, and disallow usage of this entity. Refers to "Item group name" value of item_inventory.}}
{{Entity_keyvalue|Inventory: Item count in group CAN'T have|item_group_canthave_num|Minimal number of items in player inventory, which belong to specified group, that will fail the test, and disallow usage of this entity. Refers to "Item group name"
value of item_inventory. Value of '0' means no single item from current group should be equipped to pass the test.}}
{{Entity_keyvalue|On pass: Ignore item's on use triggers?|pass_ignore_use_triggers|If set to 'Yes' item's trigger targets from 'Target: On use (by trigger)' will not be fired when item is used by this entity.}}
{{Entity_keyvalue|On pass: Drop item(s)|pass_drop_item_name|Items to force-drop when the test result is positive, and entity is used successfully. Refers to "Item name" value of item_inventory. Multiple item names are separated by spaces.}}
{{Entity_keyvalue|On pass: Drop item(s) from group(s)|pass_drop_item_group|Items to force-drop, that belong to specified group, when the test result is positive, and entity is used successfully. All items from this group will be dropped.
Refers to "Item group name" value of item_inventory. Multiple item names are separated by spaces.}}
{{Entity_keyvalue|On pass: Ignore item's on drop triggers?|pass_ignore_drop_triggers|If set to 'Yes' item's trigger targets from 'Target: On drop' will not be fired when item is dropped by this entity with 'Drop items(s)' events above.}}
{{Entity_keyvalue|On pass: Return item(s)|pass_return_item_name|Items to return to their starting positions when test result is positive. Refers to "Item name" value of item_inventory. Multiple item names are separated by spaces.}}
{{Entity_keyvalue|On pass: Return item(s) from group(s)|pass_return_item_group|Items, that belong to specified group, to return to their starting positions when test result is positive. All items from this group will be returned. Refers to "Item group name" value of item_inventory. Multiple group names are separated by spaces.}}
{{Entity_keyvalue|On pass: Ignore item's on return triggers?|pass_ignore_return_triggers|If set to 'Yes' item's trigger targets from 'Target: On return' will not be fired when item is returned by this entity with 'Return items(s)' events above.}}
{{Entity_keyvalue|On pass: Destroy item(s)|pass_destroy_item_name|Items to remove when test result is positive. Refers to "Item name" value of item_inventory. Multiple item names are separated by spaces.}}
{{Entity_keyvalue|On pass: Destroy item(s) from group(s)|pass_destroy_item_group|Items, that belong to specified group, to remove when test result is positive. All items from this group will be removed. Refers to "Item group name" value
of item_inventory. Multiple group names are separated by spaces.}}
{{Entity_keyvalue|On pass: Ignore item's on destroy triggers?|pass_ignore_destroy_triggers|If set to 'Yes' item's trigger targets from 'Target: On Destroy' will not be fired when item is destroyed by this entity with 'Destroy items(s)' events above.}}
{{Entity_keyvalue|Target: Inventory rules failed|target_on_fail|Entity to trigger whenever test result is negative.}}
{{Entity_keyvalue|Use Type|use_type|Set the use-type with which the button will fire its targets. Default is 'Toggle'.}}

== Issues ==
Buttons are able to be pushed from behind walls (within a certain thickness) completely outside line-of-sight. If you want to prevent this, consider making adjustments to the button's position, or using a setup that locks the button via [[multisource]] that unlocks when a player reaches a trigger that is directly in front of the button so that it is usable from there.
== Flags ==

{{Entity_flag|1|Don't move|If set, this func_button won't move when pressed and be activated instantly instead.}}
{{Entity_flag|32|Toggle|If set, this func_button will ignore its delay before reset and be toggleable instead, switching between the texture states whenever pressed, if such a texture is assigned on one of its faces. The delay before reset still needs to be greater than zero in order for this to work, though.}}
{{Entity_flag|64|Sparks|If set, the func_breakable ocassionally emits sparks. You can use this for easily creating buttons which appear to be broken.}}
{{Entity_flag|256|Touch activates|If set, this func_button can be activated by touching it. This disables activating per use-key.}}

== Changes ==

5.0 Steam Release: Added 'Inventory Rules', 'Sound Override', 'Locked Sound Override', 'Unlocked Sound Override',
'Locked Sentence Override' and 'Unlocked Sentence Override' keyvalues.
5.11: Added 'Use Type' keyvalue.

{{entity_title}}

[[Category:Entities]]
[[Category:Brush entities]]