CWorld (CS)

From AlliedModders Wiki
Jump to: navigation, search


Basic Information

  • Classname: CWorld.
  • Linked Entity: worldspawn.
  • Description: A special entity that controls several global properties. Created automatically, and can be found in Hammer under Map > Map Properties. This spawns first when each level begins.


Class Hierarchy


HLSDK Reference


Entity Properties

None.


Entity Attributes

  • Map Description/Title (message) - Displays this text on entering the world.
  • Environment Map (skyname) - Lets you choose what sky image you want.
Values are: 2desert, alien1, alien2, alien3, black, city, cliff, desert, dusk, morning, neb1, neb2, neb6, neb7, night, space, xen8, xen9, xen10.
More skies exist in Half-Life modifications, and you can also make your own skies.
  • CD track to play (sounds) - CD track to play when the level begins.
  • Default light level (light)
  • Default Wave Height (WaveHeight) - Set the default wave height here (can be overridden by the properties in func_water).
  • Max viewable distance (MaxRange) - Maximum distance the player can see.
  • Chapter title message (chaptertitle) - Text displayed when entering the level.
  • Level Fade-in (startdark) - 0 = No, 1 = Yes. If Yes, then the level will start black and fade into normal light.
  • Display game title (gametitle) - 0 = No, 1 = Yes. If Yes, then "Half-Life" will be displayed after the map loads.
  • New Level Unit (newunit) - 0 = No, 1 = Yes. If Yes, all previous global triggers will be removed.
  • Map team List (mapteams) - This will be copied into the mp_teamlist while your map is running if the server allows maps to override the team list.
  • Default Team (defaultteam) - 0 = Fewest Players, 1 = First Team (team index 0).


Entity Flags

// Spawn flags
#define SF_WORLD_DARK	    0x0001  // Fade from black at startup
#define SF_WORLD_TITLE	    0x0002  // Display game title at startup
#define SF_WORLD_FORCETEAM  0x0004  // Force teams


Notes

None.


( source : TWHL )