This article relates to the game "Team Fortress 2". Click here for more information.

Tf logic holiday: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
 
(24 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{tf2 point|tf_logic_holiday}}
{{LanguageBar}}
{{stub}}
{{TF2 topicon}}
{{Stub}}
{{CD|CTFHolidayEntity|file1=1}}
{{this is a|logical entity|name=tf_logic_holiday|game=Team Fortress 2}}


==Entity description==
Holiday Entity. This is used to force a specific holiday on a map, usually Halloween.
Controls special events in the game.


==Keyvalues==
This entity is also used to enable the Spell UI via its HalloweenSetUsingSpells input.
 
== Keyvalues ==
{{KV Targetname}}
{{KV Targetname}}
{{KV|Holiday|choices|Controls the special events.}}
{{KV|intn=holiday_type|Holiday|integer choices|Controls the special events.
:{| class=standard-table
:* 1: "None"
!| Value || Description
:* 2: "Birthday" - Setting to this enables the use of Birthday-restricted gear on the map. In addition, all actions which would normally draw blood will produce random party effects and there is a chance of a birthday beach ball spawning on the map.  
|-
:* 3: "Halloween" - Setting to this enables the use of Halloween-restricted gear on the map as well as causes halloween candy (which provides a brief mini-crit effect when collected) to randomly drop from killed players.}}
| None || No special event.
:{{Todo|See if there are other effects associated with the events.}}
|-
{{KV|intn=tauntInHell|Taunt in Hell|integer choices|Should players taunt when teleported to Hell.}}
| Birthday || ''Birthday event.'' Setting to this enables the use of Birthday-restricted gear on the map. In addition, all actions which would normally draw blood will produce random party effects and there is a chance of a birthday beach ball spawning on the map.
{{KV|intn=allowHaunting|Haunting|integer choices|Allow Wheel of Doom haunting.}}
|-
:{{note|{{mono|tauntInHell}} and {{mono|allowHaunting}} are defined in game code as integers, but are treated as [[boolean]]s; any value greater than 0 is treated as true.}}
| Halloween || ''Halloween event.'' Setting to this enables the use of Halloween-restricted gear on the map as well as causes halloween candy (which provides a brief mini-crit effect when collected) to randomly drop from killed players.
|}
{{todo|See if there are other effects associated with the events.}}
 
==Inputs==
{{I Targetname}}


==Outputs==
== Inputs ==
{{O Targetname}}
{{I|HalloweenSetUsingSpells|param=integer|Disable/Enable spells for this map. Only works on Halloween maps.}}
:{{note|This affects whether or not players drop spells on death and whether or not spells appear on the HUD. [[tf_spell_pickup|Spells placed in the map via. Hammer]] will work regardless.}}
:{{note|This input is defined in game code as taking an integer, but treats it like a [[boolean]]; 0 is false (disable spells), and any other value is true (enable spells).}}
{{I|Halloween2013TeleportToHell|param=string|Used by {{tfwiki|Helltower}}. Teleports all players to Hell, granting them health, ammo and normal rarity spells. The winning team passed by the input parameter is granted overheal. Players spawn in Hell at <code>spawn_loot_winner</code> or <code>spawn_loot_loser</code> named entities depending on which team they were on.}}
:* <code>red</code> : Sets the RED team as the winning team
:* anything else : Sets the BLU team as the winning team

Latest revision as of 16:11, 5 June 2025

English (en)Translate (Translate)

Stub

This article or section is a stub. You can help by expanding it.

C++ Class hierarchy
CTFHolidayEntity
CPointEntity
CBaseEntity
C++ tf_gamerules.cpp

tf_logic_holiday is a logical entity available in Team Fortress 2 Team Fortress 2.

Holiday Entity. This is used to force a specific holiday on a map, usually Halloween.

This entity is also used to enable the Spell UI via its HalloweenSetUsingSpells input.

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

Holiday (holiday_type) <integer choices>
Controls the special events.
  • 1: "None"
  • 2: "Birthday" - Setting to this enables the use of Birthday-restricted gear on the map. In addition, all actions which would normally draw blood will produce random party effects and there is a chance of a birthday beach ball spawning on the map.
  • 3: "Halloween" - Setting to this enables the use of Halloween-restricted gear on the map as well as causes halloween candy (which provides a brief mini-crit effect when collected) to randomly drop from killed players.
Todo: See if there are other effects associated with the events.
Taunt in Hell (tauntInHell) <integer choices>
Should players taunt when teleported to Hell.
Haunting (allowHaunting) <integer choices>
Allow Wheel of Doom haunting.
Note.pngNote:tauntInHell and allowHaunting are defined in game code as integers, but are treated as booleans; any value greater than 0 is treated as true.

Inputs

HalloweenSetUsingSpells <integerRedirectInput/integer>
Disable/Enable spells for this map. Only works on Halloween maps.
Note.pngNote:This affects whether or not players drop spells on death and whether or not spells appear on the HUD. Spells placed in the map via. Hammer will work regardless.
Note.pngNote:This input is defined in game code as taking an integer, but treats it like a boolean; 0 is false (disable spells), and any other value is true (enable spells).
Halloween2013TeleportToHell <stringRedirectInput/string>
Used by Tfwiki favicon.png Helltower. Teleports all players to Hell, granting them health, ammo and normal rarity spells. The winning team passed by the input parameter is granted overheal. Players spawn in Hell at spawn_loot_winner or spawn_loot_loser named entities depending on which team they were on.
  • red : Sets the RED team as the winning team
  • anything else : Sets the BLU team as the winning team