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

skybox_swapper

From Valve Developer Community
Jump to navigation Jump to search
English (en)Español (es)Translate (Translate)
Info.png
This entity is not in the Alien SwarmPortal 2 FGD by default.
See below for instructions on making it available.
Class hierarchy
CSkyboxSwapper
CServerOnlyPointEntity
CServerOnlyEntity
CBaseEntity
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 branch Team Fortress 2 branch 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>
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) <sky name>
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."
]