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
(Now in Gmod as of the March 2025 update, though not currently in the FGD. Also cleaned up some text. The amount of games listed in template:also is a bit much though. Also clarified why exactly skybox_swapper doesn't work in Mapbase.)
No edit summary
Line 2: Line 2:
{{ent not in fgd}}
{{ent not in fgd}}
{{CD|CSkyboxSwapper|link=/asw|file1=1}}
{{CD|CSkyboxSwapper|link=/asw|file1=1}}
{{this is a|point entity|since=Alien Swarm|name=skybox_swapper}} {{also|{{tf2branch}}{{mapbase}}{{gmod}}}}.
{{this is a|logical entity|since=Alien Swarm|name=skybox_swapper}} {{also|{{tf2branch}}{{mapbase}}{{gmod}}}}.
Precaches and replaces the current 2D skybox material with another. Functionally equivalent to sv_skyname, even using the command in its functionality.
Precaches and replaces the current 2D skybox material with another. Functionally equivalent to sv_skyname, even using the command in its functionality.
{{Note|Due to engine differences between {{srcsdk13sp}} and {{srcsdk13mp}}, this entity doesn't actually work in {{mapbase|4}}.}}
{{Note|Due to engine differences between {{srcsdk13sp}} and {{srcsdk13mp}}, this entity doesn't actually work in {{mapbase|4}}.}}

Revision as of 04:14, 29 April 2025

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 logical entity available in all Source Source games since Alien Swarm Alien Swarm. (also in Team Fortress 2 branchMapbaseGarry's Mod). 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 to engine differences between Source SDK Base 2013 - Singleplayer and Source SDK Base 2013 - Multiplayer, 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) <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."
]

>