Worldspawn

From Valve Developer Community
Jump to: navigation, search
Deutsch

Worldspawn (or just "the world") is the single entity that stores the noninteractive parts of a map, alongside some global configuration options. In other words:

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.) 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.
  • 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.

See also

Related entities

There are a few other 'map property' entities which should not have more than one instance in a map. They are:

Skybox
env_fog_controller (only in pre-L4D games)
light_environment
shadow_control
sky_camera (Multiple 3D skyboxes are actually possible. See here.)
Optimisation
game_ragdoll_manager
game_weapon_manager
game_gib_manager
water_lod_control
Logic
game_end
info_intermission (unique location)
env_global


Keyvalues

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

All Source games

Map Description / Title. <string>
Map's description / title.
Note:Doesn't seem to be used anywhere anymore.
SkyBox Texture Name <string>
Skybox material. See Sky List.
Chapter Title Message <string>
Chapter Title that appears onscreen when this level starts.
Level Fade In <boolean>
Fades the map in.
Bug: The fade is carried out every time the map loads, including when loading from a saved game. Use env_fade instead.
Display Game Title <boolean>
Should the game's title appear on-screen when the map starts?
New Level Unit <choices>
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.
  • 0 : No, keep current
  • 1 : Yes, clear previous levels
Max occludee area <float>
[Used on PC] Prevents occlusion testing for entities that take up more than X% of the screen.
Min occluder area <float>
[Used on PC] Prevents occluders from being used if they take up less than X% of the screen.
Max occludee area (Xbox) <float>
[Used on 360] Prevents occlusion testing for entities that take up more than X% of the screen.
Min occluder area (Xbox) <float>
[Used on 360] Prevents occluders from being used if they take up less than X% of the screen.
Start Fade Pixels <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 <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 <string>
Detail.vbsp file to use for emitting detail props (found in directory <root>/modname)
Detail material file <string>
Material for detail sprites to use for drawing detail props
World is cold <boolean>
If set, Day of Defeat: Source player models will emit breath particles from their mouth attachments. No effect elsewhere.
_minlight <float>
The minimum level of ambient light that hits the world. It does not affect any entities, including props! !FGD

ResponseContext:

Response Contexts <string>
Pre-defined response system contexts for this entity. Format is key:value,key:value,...

Left 4 Dead 2

Time of day <choices>
Witches will wander if set to "afternoon" otherwise this has no purpose.
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 <choices>
Music type of the safe room.
  • 0 : Mission Start
  • 1 : Check Point
Music Post-Fix String <string>
The musical theme of the map.

Portal 2

Paint in map <boolean>
Allow paint to cover surfaces? Set to No to save resources for maps that don't use paint.
Max number of blobs <integer>
Maximum number of paint blobs. Should NOT exceed 250.
Note:These two parameters might not appear if you have propper.fgd in hammer.

Inputs

ResponseContext:

AddContext <string>
Adds to the entity's list of response contexts. Format is <key>:<value>.
RemoveContext <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.