Worldspawn

GoldSrc

Source Engine

Source 2

edit

Class hierarchy
CWorld ↳CBaseEntity
world.cpp

This is a preserved entity.
If the game has round restart mechanics this entity may not behave as expected.

worldspawn is a semi-internal entity available in all Source games. It (or just "the world") is the single entity that stores the noninteractive parts of a map, alongside some global configuration options. In other words:

• Brushes (except those used by entities)
• Static props
• func_detail, and in some games func_ladder
• Map name, skybox, contexts...

Some other notes:

• There can be only one. (Since Hammer doesn't allow worldspawn to be created directly, it's very difficult for this rule to be broken.)

Bug:Related to this, do not clone any part of your world after selecting it via map properties. This will duplicate worldspawn, causing crashes. Deselecting after this however and cloning after deselecting will behave as normal. (fixed in )   [todo tested in ?]

• Damage from the environment and suicide is ordinarily attributed to the world.
• Constraints can be assigned to worldspawn by not specifying a name for their subject/target.

Note:Attempting to kill worldspawn or create a second worldspawn while the game is running will crash the server.

Keyvalues

Tip:Access these properties in Hammer with Main menu > Map > Map properties...

All Source Games

Targetname (targetname) <string>

Name which other entities use to send inputs to this entity.

Map Description / Title (message) <string> 

Deprecated.
Leftover from Quake I. Typically used for author credits.

Skybox Name (skyname) <sky name>

Skybox material, relative to materials/skybox/. See Sky List.

Chapter Title Message (chaptertitle) <string>

Chapter Title that appears on-screen when this level starts.

Level Fade In (startdark) <boolean>

Fade in when the map loads.

Bug:The fade is carried out every time the map loads, including when loading from a saved game. Use env_fade instead.  [todo tested in ?]

Display Game Title (gametitle) <boolean>

Should the game's title appear on-screen when the map starts?

Bug:Crashes the game when enabled if the game tries to draw the title but does not include title_half and title_life entries in /scripts/hud_textures.txt.
Half-Life: Source is one of the games that does have them, for example.

Confirm:Which other games have them, or don't use this method in the first place?

  [todo tested in ?]

Fix:Add title_half and title_life entries to hud_textures.txt.

Example from HL:S 

"title_half"
{
     "file" "sprites/640hud4"
     "x" "0"
     "y" "226"
     "width" "256"
     "height" "30"
}
"title_life"
{
     "file" "sprites/640hud5"
     "x" "0"
     "y" "226"
     "width" "220"
     "height" "30"
}

A proper fix in the code for your mod would be to edit /game/client/message.cpp's Paint() function, to check m_iconTitleHalf and m_iconTitleLife not being NULL.

New Level Unit (newunit) <boolean>

Used to clear out savegame data of previous levels to keep the savegame size as small as possible. Only set it to Yes if the player cannot return to any previous levels.

Note: Portal 2 forces this to be enabled in code, so two-way transitions will not work correctly (one-way HL2 style transitions work fine though.)

• 0 : No, keep current
• 1 : Yes, clear previous levels

Max occludee area (maxoccludeearea) <float>

Min occluder area (minoccludeearea) <float>

Prevents occlusion testing for entities that take up more or less than X% of the screen, respectively.

Max occludee area (Xbox) (maxoccludeearea_x360) <float>

Min occluder area (Xbox) (minoccludeearea_x360) <float>

Same as above, but for Xbox 360.

Start Fade Pixels (maxpropscreenwidth) <float>

Number of pixels wide at which all props in the level start to fade (<0 = use fademaxdist). This number is ignored if the prop has a specific fade distance specified.

End Fade Pixels (minpropscreenwidth) <float>

Minimum number of pixels wide at which the prop is visible (0 = don't fade out). This number is ignored if the prop has a specific fade distance specified.

Detail.vbsp file (detailvbsp) <file path>

Detail.vbsp file to use for emitting detail props (relative to the mod's root directory)

Detail material file (detailmaterial) <material>

Material for detail sprites to use for drawing detail props

World is cold (coldworld) <boolean>

If set, Day of Defeat: Source player models will emit clientside breath particles from their head attachments. No effect elsewhere.

Idea:Set this properly even if unused in the given game. If VScript is available then vscript mods may potentially use the information and implement similar functionality to .

Minimum light level (_minlight) <float> !FGD

The minimum level of ambient light that hits the world. It does not affect any entities, including props!

World MinS (world_mins) <vector3> !FGD

Autofilled by VBSP.

World MaxS (world_maxs) <vector3> !FGD

Autofilled by VBSP.

Map revision (mapversion) <integer> !FGD

Updated by Hammer each time the VMF is saved.

ResponseContext:

Response Contexts (ResponseContext) <string>

Pre-defined response system context{s} for this entity. Format is key:value,key:value,... When this entity speaks, the list of keys & values will be passed to the response rules system.

Specific games

Valve games

Left 4 Dead 2 Time of day (timeofday) <integer choices> Common infected will aggro from a further distance if set to "Dawn" through "Dusk" and will sit or lie down if set to "Midnight" or "Evening". Witches will wander if set to "Afternoon". Note:Doesn't influence lighting or environment in any way. You still need to configure the light_environment so the sun/moon has the appropriate light color and brightness. 0 : Midnight 1 : Dawn 2 : Morning 3 : Afternoon 4 : Dusk 5 : Evening Start Music Type (startmusictype) <boolean> Music type of the safe room. 0 : Mission Start 1 : Check Point Music Post-Fix String (musicpostfix) <string> The musical theme of the map. Portal 2 Paint in map (paintinmap) <boolean> Allow paint to cover surfaces? Set to No for better optimization of levels without it. Max number of blobs (maxblobcount) <integer> Maximum number of paint blobs. Should NOT exceed 250. Note:These two parameters might not appear if you have propper.fgd in Hammer.

Non-Valve games

Black Mesa Under Water Particles (underwaterparticle) <string choices> underwater_default : Rubbish underwater_ion : Blue ions underwater_tentacle_water : Tentacle feces water Strata Source Maximum Projected Textures (maxprojectedtextures) <integer> Maximum number of env_projectedtexture entities that can be enabled at once. Default 8; set lower to improve performance if necessary. Warning:While this can be set higher than 8, doing so can be detrimental to performance. SiN Episodes Arena Mode Time Limit (arenaTimeLimit) <integer> The number of seconds an arena mode map should last. (default: 900s (15 min))

Inputs

SetChapterTitle <stringRedirectInput/string> (only in )

Change the Chapter Title

ResponseContext:

AddContext <stringRedirectInput/string>

Adds to the entity's list of response contexts. Format is <key>:<value>.

RemoveContext <stringRedirectInput/string>

Remove a context from this entity's list. The name should match the key of an existing context.

ClearContext

Removes all contexts from this entity's list.

See also

• Void
• Skybox