View source for Counter-Strike: Global Offensive/Game Modes/Wingman

{{Lang|CS:GO Game Modes/Wingman}}
{{back|Counter-Strike: Global Offensive Level Creation}}
[[File:Csgo icon wingman.png|left|link=]]
'''Wingman''' (internally: <tt>'''scrimcomp2v2'''</tt>) is a [[CS:GO Game Modes|game mode]] in {{csgo|4}}.

Here, you can learn how to modify a Competitive map for it, and how all of this works.

A map is launched in the Wingman game mode with the commands <code>game_type 0; game_mode 2; [[map (console command)|map]] <mapname></code>, or shorter: <code>map <mapname> scrimcomp2v2</code>.
{{clr}}
__TOC__

== Game Mode Description ==
{| class="standard-table" style="float:right;"
|+ Pivotal ([[CFG]]) differences
! Property !! {{csgo mode|comp}} Competitive !! {{csgo mode|wingman}} Wingman
|-
| ''Players per team'' || 5 || 2
|-
| Best of || 30 || 16
|-
| Roundtime in minutes || 1:55 || 1:30
|-
| Freezetime in seconds || 15 || 10
|-
| Max Money || $16000 || $8000
|}
Technically, this game mode is almost equal to the {{csgo mode|Competitive}} game mode.
The round ending events are equal, meaning that this game mode can be played with [[func_bomb_target|bombsites]], [[hostage_entity|hostages]] or none of them.
The crucial differences are the game mode's [[CFG]] file (see the table on the right) and [[maxplayers]].

Officially, the game mode plays as follows:
* Two teams of two [[player]]s play a match in a competitive environment.
* There is one accessible [[func_bomb_target|bombsite]].

== Adding Wingman Support to a Map ==

Any {{csgo mode|Comp}} map can be modified to support {{csgo mode|Wingman}} in the same way as ''Cobblestone'', ''Inferno'', ''Nuke'', ''Overpass'', ''Vertigo'' and ''Train''.
These maps are actually too large for Wingman, but if they are launched in Wingman, the spawn points and buyzones are "shifted" if needed and there are blockers that limit the playable area to only one bombsite.

The following sections are about how mapmakers can reproduce this.

{{important|If you are designing your map for Wingman such that no spawn shifting or blocking needs to be done, then you don't need this tutorial.}}
{{note|''de_nuke'' doesn't actually support Wingman, instead Valve uses a different map ''de_shortnuke'' which is literally half of ''de_nuke'', only consisting of the interior parts for bombsite B.}}

=== Scripting ===
{| class="wikitable mw-collapsible mw-collapsed" style="float:right; margin:1em; background-color:transparent"
! <code>csgo/scripts/vscripts/2v2/2v2_enable.nut</code>
|-
|
<syntaxhighlight lang=cpp highlight=22>
// This function is called from the map OnMapSpawn

function EnableWingman()
{
       // checks the game mode and type and the current match
       local nMode = ScriptGetGameMode();
       local nType = ScriptGetGameType();

       // type 0, mode 0 = casual
       // type 0, mode 1 = competitive
       // type 1, mode 0 = arms race
       // type 1, mode 1 = demolition
       // type 1, mode 2 = deathmatch
       // etc 

	   
	if (nMode == 2 && nType == 0)								// if we are running 2v2, do stuff
	{
	  EntFire("spawnpoints.standard", "SetDisabled", 0, 0);
	  EntFire("spawnpoints.2v2", "SetEnabled", 0, 0);
	  EntFire("brush.blocker", "Enable", 0, 0);
	  EntFire("buyzone.2v2", "SetEnabled", 0, 0);
	  EntFire("navblocker.2v2", "BlockNav", 0, 0);
	}
	else
	{
	  EntFire("buyzone.2v2", "Disable", 0, 0);				// disable 2v2 buyzones
	  EntFire("navblocker.2v2", "UnblockNav", 0, 0);
	}
  
 }
</syntaxhighlight>
{{bug|The highlighted line doesn't have the intended effect, because <code>SetEnabled</code> is not a valid input for [[func_buyzone]].}}
|}
To shift spawn points or block areas '''only''' in Wingman, our map must [[CS:GO Game Modes#Game Mode dependent Events|detect the current game mode]] which requires [[VScript]]ing.
Fortunately, Valve has already made a VScript that does that (seen on the right) and made it available to everyone, so you don't have to write any code.
{{note|Making an own script is also an option; but don't forget to pack custom scripts to the map when [[CS:GO Map Publish Tool|publishing]]!}}

To run this script, create a {{ent|logic_script}} entity in your map, and give it the [[targetname]] '''script.2v2''' (arbitrary).
Set its <code>Entity Scripts</code> property to <code>2v2/2v2_enable.nut</code>.

Then create a {{ent|logic_auto}} with the following [[output]]:
{| {{OutputsTable|sortable=0}}
| [[File:io11.png|link=]] || OnMapSpawn || script.2v2 || RunScriptCode || EnableWingman() || 0 || No
|}

Every round, this will run the <code>EnableWingman</code> function which fires [[I/O]] events to some named entities in our level depending on the current game mode.
That's why all of the following entity names are required to be exactly as in the above VScript, otherwise it will not work.

=== Spawn points and Buyzones ===

First, select all of the normal spawn points, both [[info_player_counterterrorist|CT and T]], and change their names to '''spawnpoints.standard'''. The script will deactivate these in Wingman.

Now, create at least two spawn points for each team that should be used in Wingman. In the official Valve maps, they use 4 for each team.
Select them all, name them '''spawnpoints.2v2''' and set <code>Enable by default?</code> to <code>No</code>.

If these spawns are not already inside of a {{ent|func_buyzone}}, create one for them, select the team and name it '''buyzone.2v2'''. Do the same for the other team.
{{bug|
Set all buyzones to start enabled! In Valve's script, <code>EnableWingman()</code> does never enable any buyzone in any game mode because <code>"SetEnabled"</code> (which is used in that script) is not a valid input for <tt>func_buyzone</tt>. The script is still useful though, as it <tt>Disable</tt>s the Wingman buyzone when needed.
Also, the script does not disable the standard buyzones in Wingman for the case that no spawn shifting is done. If this is an issue, write your own script and fix this or find a different solution.
}}

=== Blocking the Playable Area ===

[[Image:Toolswrongway.png|thumb|192px|The <code>tools/wrongway</code> [[tool texture]] is only visible to players close to the origin of the entity that this material is applied to.]]
The game can work as it is now, but you will probably want only one [[func_bomb_target|bombsite]] to be reachable.

To do that, create some [[clip texture|clip brush]]es with the <code>tools/toolsclip</code> texture in the places that you don't want the [[player]]s to go. Tie them to {{ent|func_brush}}es and name them '''brush.blocker'''. Set <code>Start disabled</code> to <code>Yes</code> and the script will enable them only in Wingman.

You can even make more of those and use the cool <code>tools/wrongway</code> texture to signalize to players that there is an invisible wall. It even fades out with distance! For these brushes, it is good practice to set their <code>Solidity</code> to <code>Never Solid</code> if they are already inside a larger '''brush.blocker''' because then their collision is not needed.

=== Blocking Navigation Meshes ===

Now the '''brush.blocker'''s will do a great job on blocking players, however, [[bot]]s might still try to walk through the blockers.

Create {{ent|func_nav_blocker}} brush entities inside the '''brush.blocker'''s with the <tt>tools/toolstrigger</tt> texture and name them '''navblocker.2v2'''.
The VScript will finally fire <tt>BlockNav</tt> to these entities in Wingman or <tt>UnblockNav</tt> in all other game modes, informing the bots whether the area is blocked or not.
{{tip|If bots keep trying to walk through the blockers, then the <tt>func_nav_blocker</tt> might not be blocking the [[Nav Mesh]] areas of interest. For visualization, use the cheat {{ent|nav_edit|1}}. Areas blocked by nav blockers are [[Nav Mesh Editing#Area Attributes|marked]] with a <span style{{=}}color:cyan>cyan rectangle</span> along its border.}}

== Testing and Uploading ==

To play a map in Wingman mode, type in the commands <tt>[[game_type]] 0; game_mode 2</tt> into the console and then enter the <tt>[[map (console command)|map]]</tt> command to access your map.

When you upload the map to the workshop, be sure to select "Wingman" in the list of game modes so that people can select that when they open the map through the in-game workshop tab.
Done!

{{csgo-navbox}}
[[Category: Counter-Strike: Global Offensive]]
[[Category: Level Design]]
[[Category: Tutorials]]