Custom sound pitches for page collection sounds either via sf2_gamerules or individual sf2_info_page_spawn entities.
Added sf2_trigger_boss_despawn trigger entity; despawns any boss that enters it.
Added Bodygroup support for page spawns (though this is a bit experimental)
sf2_game_text now has variable support! More info in the variable support section below.
Added SetSurviveUntilTime and AddTime inputs for sf2_gamerules
Added OnCollected[0-32]Pages and OnDifficulty[0-5] outputs for sf2_gamerules
sf2.fgd now uses custom made sprites and models, courtesy of @xChillax! Link to assets
Changes:
Page messages and intro text sequence revamp! This means that sf2_page_message, sf2_intro_text_# and sf2_intro_message are deprecated.
sf2_escape_message is now deprecated; Use sf2_gamerules instead via Escape Text Entity property or the SetEscapeTextEntity input.
sf2_onpagecount_# is now deprecated; Use sf2_gamerules's OnCollectedXPages and OnCollectedPagesChanged outputs instead
sf2_trigger_pvp and sf2_trigger_escape will automatically have the Clients spawnflag turned on upon spawning.
Renamed sf2_logic_survival2 to sf2_logic_elimination
Variable Support for sf2_game_text
The sf2_game_text entity now supports variables in its Message property. The following variables are available to allsf2_game_text entities:
<br> - Line break
<maxPages> - Number of pages spawned in the map.
<pageCount> - Number of pages collected so far.
<pagesLeft> - Number of pages left to collect.
To use a variable, insert the variable name anywhere in your sf2_game_text's Message. For example:
Example 1: Collected <pageCount> out of <maxPages> pages
Displays: Collected 1 out of 8 pages
Example 2: <pageCount>? Just <pageCount>? That's not enough!
Displays: 1? Just 1? That's not enough!
Escaping characters is not supported.
Page Messages Revamp
To determine a sf2_game_text entity to show when collecting a page, use the Page Text Entity property of sf2_gamerules, or the SetPageTextEntity input along with the Name of the entity. Changing page text entities mid-game or even upon collecting a page is allowed.
%d is no longer used for the revamp style. This has been deprecated in favor of the new variable system introduced.
The old formatting style posed problems for map localization because of the very specific order the numbers are passed into the string (collected page count first, then max page count). Now with the variable system, localization is now easier especially for SOV languages, as the needed variables can be switched around as needed. Stripper: Source can be used for such changes.
Moreover, the variables can be used for any sf2_game_text entity; regardless if they are used as a page text entity, intro text entity, or not.
These changes DO NOT APPLY to the old entity. If you still use the sf2_page_message entity, you are still restricted to using %d and cannot use variables.
Intro Text Sequence Revamp
Like how page messages have been revamped, use the Intro Text Entity property of sf2_gamerules to determine the first intro text entity in the sequence. sf2_game_text entities have now been fitted with the Next Intro Text Entity property, which determines the next intro text entity to be shown in the intro text sequence. You are no longer restricted to a naming scheme like the old system; you can use any name you like for your text entities, just as long as they are all referenced in the correct order.
sf2_intro_message has been deprecated as well; if you were using a sf2_intro_message entity, you must now manually chain it into the intro text sequence. sf2_intro_message will not be used if the Intro Text Entity property is used in sf2_gamerules.
These changes DO NOT APPLY to the old entities. If you still use the sf2_intro_text_# or sf2_intro_message entities, you cannot use variables.
Conclusion
This marks the end of revamping the map entity system from old to new. Preferably, a map should be using either only the old or the new system. Even though a mixture of both is possible, I wouldn't recommend it as you may run into unexpected problems in your map. If any maps are currently using a mixture, you can use Stripper: Source as a band-aid fix, and have future updates of the map totally convert to the new system.
Here is a final list of the entities, comparison of old -> new.
* = exclusive to Modified
** = exclusive to Private
Old Entity
New Entity
Changes
sf2_boss_maker
Creates bosses at its location, or a custom destination set by SetSpawnDestination input. Optionally can set a spawn radius.
OnSpawn output called for each successful spawn by this entity, !activator being the boss entity that spawned.
sf2_game_text
Allows showing custom HUD text to the player's screen. Display input can now optionally take a targetname or !activator to show text to a specific player.
game_text was not usable because SF2 utilizes a lot of HUD text, and its text gets overwritten in 1/10 of a second, leading to confusion in maps that use it.
Stripper: Source can be used to replace existing game_text entities with sf2_game_text entities on existing maps, and using game_text is strongly discouraged for future maps.
sf2_trigger_boss_despawn
A trigger brush that despawns bosses that enter it.
sf2_adventure_map**
sf2_gamerules
Is Adventure Map property
sf2_bossoverride(name)
sf2_gamerules
SetBossOverride and ClearBossOverride inputs
sf2_bosses_chase_endlessly*
sf2_gamerules
Bosses Chase Endlessly property and Enable/DisableBossesChaseEndlessly inputs
sf2_boxing_map*
sf2_logic_boxing
sf2_boxing_boss_spawn*
Unchanged
sf2_classic_map**
sf2_gamerules
Is Classic Map property
sf2_escape_custommusic
sf2_gamerules
Stop Page Music on Escape property
sf2_escape_map**
sf2_gamerules
Is Escape Map property
sf2_escape_message
sf2_game_text
Entity referenced by Escape Text Entity property of sf2_gamerules; can also be set using SetEscapeTextEntity input
sf2_escape_spawnpoint
sf2_info_player_escapespawn
Allows multiple instances of spawn points and Enable/Disable inputs for more control over spawn locations
OnSpawn output is fired for players that spawn at the entity, !activator being the player.
sf2_escape_timelimit#
sf2_gamerules
Escape Time Limit property and SetEscapeTimeLimit input
sf2_escape_trigger
sf2_trigger_escape
Additionally can takes filters into account
sf2_infiniteblink
sf2_gamerules
Infinite Blink property and Enable/DisableInfiniteBlink inputs
sf2_infiniteflashlight
sf2_gamerules
Infinite Flashlight property and Enable/DisableInfiniteFlashlight inputs
sf2_infinitesprint
sf2_gamerules
Infinite Sprint property and Enable/DisableInfiniteSprint inputs
sf2_intro_fade
sf2_gamerules
Intro Fade Color, Intro Fade Time, and Intro Fade Holdtime properties
sf2_intro_message
Deprecated
sf2_intro_music
sf2_gamerules
Intro Music Path property
sf2_intro_relay
sf2_gamerules
OnStateEnterIntro output
sf2_introtext#
sf2_game_text
Starting text referenced by Intro Text Entity property of sf2_gamerules; subsequent text entities referenced by Next Intro Text Entity property of sf2_game_text
sf2_logic_escape
sf2_gamerules
Escape to Win property
For OnUser1 output equivalent, use OnStateEnterEscape.
sf2maxpages#
sf2_gamerules
Max Pages property
sf2maxplayers#
sf2_gamerules
Max Players property
sf2_nav_interface
Unchanged
sf2_nojumprestrict**
sf2_info_jumprestrict
Allows enabling/disabling the jump restriction via Stamina Jump Restriction property and the Enable/DisableStaminaJumpRestriction inputs.
sf2onpagecount#
sf2_gamerules
OnCollectedXPages and OnCollectedPagesChanged outputs
sf2_page_model sf2_page_spawnpoint
sf2_info_page_spawn
Allows ability to have different models, skin, model scale, etc. for each page spawn point, as well as specify page group via the Group property. You no longer have to guess how the page will look when spawned. Supports physics simulation in Hammer++ for ultra-realistic placement!
sf2_page_message
sf2_game_text
Entity referenced by Page Text Entity property of sf2_gamerules; can also be set using SetPageTextEntity input
sf2_pagemusic#-#
sf2_info_page_music
Contains up to 16 different page ranges as well as their respective tracks. It also has default values filled in to showcase how the ranges should be formatted.
If you need more page ranges for whatever reason, make another of this entity.
sf2_page_sound
sf2_gamerules
Page Collect Sound property
sf2_proxy_map
sf2_logic_proxy
sf2_proxy_spawnpoint
sf2_info_player_proxyspawn
Enable/Disable inputs for more control over spawn locations
OnSpawn output fired for players that spawn at the entity, !activator being the player.
sf2_pvp_spawnpoint
sf2_info_player_pvpspawn
Enable/Disable inputs for more control over spawn locations
OnSpawn output fired for players that spawn at the entity, !activator being the player.
sf2_pve_trigger**
sf2_trigger_pve
sf2_pvp_trigger
sf2_trigger_pvp
sf2_raid_map
sf2_logic_raid
sf2_renevant_map*
sf2_logic_arena
Contains inputs for controlling waves + outputs of waves triggered and Finale Time property
sf2_survival2_map
sf2_logic_elimination
sf2_survival_map
sf2_gamerules
Survive before Escape property
sf2_survival_timelimit#
sf2_gamerules
Survive Until Time property
sf2_slaughterrun_map*
sf2_logic_slaughter
sf2spawn(name)
sf2_info_boss_spawn
Spawns an active boss with the matching profile name defined in Boss Profile property. Use Spawn input to spawn the boss.
OnSpawn output fired for boss entities that spawn at the entity, !activator being the boss entity that spawns.
sf2_time_gain_frompage#
sf2_gamerules
Time to Add on Page Collect property and SetTimeToAddOnCollectPage input
Final round.
Overview
Added features:
sf2_gamerulesor individualsf2_info_page_spawnentities.sf2_trigger_boss_despawntrigger entity; despawns any boss that enters it.sf2_game_textnow has variable support! More info in the variable support section below.SetSurviveUntilTimeandAddTimeinputs forsf2_gamerulesOnCollected[0-32]PagesandOnDifficulty[0-5]outputs forsf2_gamerulessf2.fgdnow uses custom made sprites and models, courtesy of @xChillax! Link to assetsChanges:
sf2_page_message,sf2_intro_text_#andsf2_intro_messageare deprecated.sf2_escape_messageis now deprecated; Usesf2_gamerulesinstead via Escape Text Entity property or theSetEscapeTextEntityinput.sf2_onpagecount_#is now deprecated; Usesf2_gamerules'sOnCollectedXPagesandOnCollectedPagesChangedoutputs insteadsf2_trigger_pvpandsf2_trigger_escapewill automatically have the Clients spawnflag turned on upon spawning.sf2_logic_survival2tosf2_logic_eliminationVariable Support for
sf2_game_textThe
sf2_game_textentity now supports variables in its Message property. The following variables are available to allsf2_game_textentities:<br>- Line break<maxPages>- Number of pages spawned in the map.<pageCount>- Number of pages collected so far.<pagesLeft>- Number of pages left to collect.To use a variable, insert the variable name anywhere in your
sf2_game_text's Message. For example:Example 1:
Collected <pageCount> out of <maxPages> pagesDisplays:Collected 1 out of 8 pagesExample 2:
<pageCount>? Just <pageCount>? That's not enough!Displays:1? Just 1? That's not enough!Escaping characters is not supported.
Page Messages Revamp
To determine a
sf2_game_textentity to show when collecting a page, use the Page Text Entity property ofsf2_gamerules, or theSetPageTextEntityinput along with the Name of the entity. Changing page text entities mid-game or even upon collecting a page is allowed.%dis no longer used for the revamp style. This has been deprecated in favor of the new variable system introduced.The old formatting style posed problems for map localization because of the very specific order the numbers are passed into the string (collected page count first, then max page count). Now with the variable system, localization is now easier especially for SOV languages, as the needed variables can be switched around as needed. Stripper: Source can be used for such changes.
Moreover, the variables can be used for any
sf2_game_textentity; regardless if they are used as a page text entity, intro text entity, or not.These changes DO NOT APPLY to the old entity. If you still use the
sf2_page_messageentity, you are still restricted to using%dand cannot use variables.Intro Text Sequence Revamp
Like how page messages have been revamped, use the Intro Text Entity property of
sf2_gamerulesto determine the first intro text entity in the sequence.sf2_game_textentities have now been fitted with the Next Intro Text Entity property, which determines the next intro text entity to be shown in the intro text sequence. You are no longer restricted to a naming scheme like the old system; you can use any name you like for your text entities, just as long as they are all referenced in the correct order.sf2_intro_messagehas been deprecated as well; if you were using asf2_intro_messageentity, you must now manually chain it into the intro text sequence.sf2_intro_messagewill not be used if the Intro Text Entity property is used insf2_gamerules.These changes DO NOT APPLY to the old entities. If you still use the
sf2_intro_text_#orsf2_intro_messageentities, you cannot use variables.Conclusion
This marks the end of revamping the map entity system from old to new. Preferably, a map should be using either only the old or the new system. Even though a mixture of both is possible, I wouldn't recommend it as you may run into unexpected problems in your map. If any maps are currently using a mixture, you can use Stripper: Source as a band-aid fix, and have future updates of the map totally convert to the new system.
Here is a final list of the entities, comparison of old -> new.
* = exclusive to Modified ** = exclusive to Private
SetSpawnDestinationinput. Optionally can set a spawn radius.OnSpawnoutput called for each successful spawn by this entity,!activatorbeing the boss entity that spawned.Displayinput can now optionally take a targetname or!activatorto show text to a specific player.game_textwas not usable because SF2 utilizes a lot of HUD text, and its text gets overwritten in 1/10 of a second, leading to confusion in maps that use it.Stripper: Source can be used to replace existing
game_textentities withsf2_game_textentities on existing maps, and usinggame_textis strongly discouraged for future maps.SetBossOverrideandClearBossOverrideinputsEnable/DisableBossesChaseEndlesslyinputsSetEscapeTextEntityinputEnable/Disableinputs for more control over spawn locationsOnSpawnoutput is fired for players that spawn at the entity,!activatorbeing the player.SetEscapeTimeLimitinputEnable/DisableInfiniteBlinkinputsEnable/DisableInfiniteFlashlightinputsEnable/DisableInfiniteSprintinputsOnStateEnterIntrooutputFor
OnUser1output equivalent, useOnStateEnterEscape.Enable/DisableStaminaJumpRestrictioninputs.OnCollectedXPagesandOnCollectedPagesChangedoutputssf2_page_spawnpoint
SetPageTextEntityinputIf you need more page ranges for whatever reason, make another of this entity.
Enable/Disableinputs for more control over spawn locationsOnSpawnoutput fired for players that spawn at the entity,!activatorbeing the player.Enable/Disableinputs for more control over spawn locationsOnSpawnoutput fired for players that spawn at the entity,!activatorbeing the player.Spawninput to spawn the boss.OnSpawnoutput fired for boss entities that spawn at the entity,!activatorbeing the boss entity that spawns.SetTimeToAddOnCollectPageinputSetTimeLimitinput