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

Skybox swapper: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(hl2dm has this entity now after the anniversary update (switched to tf2 "subbranch" of source 2013))
No edit summary
Line 22: Line 22:
</pre>
</pre>


[[Category:Mapbase Entities]]
<!-- for cats not added by {{this is a}} template -->
[[Category:Mapbase entities]]
[[Category:Mapbase point entities]]
[[Category:Team Fortress 2 entities]]
[[Category:Team Fortress 2 point entities]]
[[Category:Half-Life 2 Deathmatch entities]]
[[Category:Half-Life 2 Deathmatch point entities]]

Revision as of 11:58, 26 November 2024

English (en)Español (es)Translate (Translate)
Icon-NotInFGD.png
This entity is not in the Alien SwarmPortal 2 FGD by default.
See below for instructions on making it available.
C++ Class hierarchy
CSkyboxSwapper
CServerOnlyPointEntity
CServerOnlyEntity
CBaseEntity
C++ skyboxswapper.cpp

skybox_swapper is a point entity available in all Source Source games since Alien Swarm Alien Swarm. It is also available in Team Fortress 2 Team Fortress 2, Half-Life 2: Deathmatch Half-Life 2: Deathmatch and Mapbase Mapbase. Precaches and replaces the current 2D skybox material with another. Functionally equivalent to sv_skyname, even using the command in its functionality.

Note.pngNote:Due the engine difference, this entity doesn't actually work in Mapbase Mapbase

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

Skybox Material Name (SkyboxName) <string>
The name of the skybox to change to.

Inputs

Trigger
Triggers the skybox change.

FGD Code

@PointClass base(Targetname) iconsprite("editor/skybox_swapper.vmt") = skybox_swapper : "An entity that precaches skybox materials and swaps them on trigger." 
[
	SkyboxName(string) : "Skybox Material Name" : ""
	input Trigger(void) : "Swap to this skybox."
]