Custom Map Makers Wiki - User contributions [en-gb]

UrTHD:Tools

2011-11-19T10:29:37Z

NemNEMnem: /* UrT Mapping Package 2.0 */

=Compiler=
==FS_q3map_Radbump_4a==
The FS_q3map_Radbump_4a is a special compiler for Bumpmapping, wich becomes a big point of mapping for UrTHD

Download: [http://www.mydevstuff.com/twoseven/q3mods/ut_bumpy_pack.rar]

Forum: [http://www.urbanterror.info/forums/topic/26742-bumpmapping-modifications-enthusiastic-mappers-required]

=Other Tools=
==UrT Mapping Package 2.0==
Hi Guys,
The 2.0 Version of my Mapping Package is now out.

Download .exe: [http://nem.viper-project.de/wp-content/uploads/2011/11/urtmappingpackage2.0.exe]

Download .zip: [http://nem.viper-project.de/wp-content/uploads/2011/11/urtmappingpackage2.0.zip]

New:
- Added Urban Terror HDa for Radiant
- Added Urban Terror 4.2 for Radiant (for those who use the iourbanterror42_bumpy_v7a.exe)
- Updated Urban Terror 4.1.1
- Bump Mapping Support
- FS_q3map_Radbump_4-Builds included
- Buildcommands for FS_q3map_Radbump_4 in the Compiler
- Added the CubeMapProbe Entity
- Removed unused quake3 entities

Install .exe:

1. Start the Installer
2. Choose your Radiantinstallationfolder.
3. Install.

Install .zip:

1. Open the .zip-file with a zipprogramm (for example 7zip).
2. Extract all files in it to your Radiantinstallationfolder.

!!!YOU HAVE TO RESTART YOUR RADIANT AFTER THE INSTALLATION!!!

Thanks to:
TwentySeven for his great compiler and the coolest .exe ever.

Tested on:
- netradiant 1.5.0 = work excellent
- GtkRadiant 1.5.0 = work excellent
- darkradiant = doesnt work well
The .zip should work on Linux and MacOS, but the new Compiler doesnt work on both.

mfg nemNEMnem

UrTHD:Tools

2011-11-19T10:29:18Z

NemNEMnem: /* FS_q3map_Radbump_4a */

=Compiler=
==FS_q3map_Radbump_4a==
The FS_q3map_Radbump_4a is a special compiler for Bumpmapping, wich becomes a big point of mapping for UrTHD

Download: [http://www.mydevstuff.com/twoseven/q3mods/ut_bumpy_pack.rar]

Forum: [http://www.urbanterror.info/forums/topic/26742-bumpmapping-modifications-enthusiastic-mappers-required]

=Other Tools=
==UrT Mapping Package 2.0==
Hi Guys,
The 2.0 Version of my Mapping Package is now out.

Download .exe: [http://nem.viper-project.de/wp-content/uploads/2011/11/urtmappingpackage2.0.exe]
Download .zip: [http://nem.viper-project.de/wp-content/uploads/2011/11/urtmappingpackage2.0.zip]

New:
- Added Urban Terror HDa for Radiant
- Added Urban Terror 4.2 for Radiant (for those who use the iourbanterror42_bumpy_v7a.exe)
- Updated Urban Terror 4.1.1
- Bump Mapping Support
- FS_q3map_Radbump_4-Builds included
- Buildcommands for FS_q3map_Radbump_4 in the Compiler
- Added the CubeMapProbe Entity
- Removed unused quake3 entities

Install .exe:

1. Start the Installer
2. Choose your Radiantinstallationfolder.
3. Install.

Install .zip:

1. Open the .zip-file with a zipprogramm (for example 7zip).
2. Extract all files in it to your Radiantinstallationfolder.

!!!YOU HAVE TO RESTART YOUR RADIANT AFTER THE INSTALLATION!!!

Thanks to:
TwentySeven for his great compiler and the coolest .exe ever.

Tested on:
- netradiant 1.5.0 = work excellent
- GtkRadiant 1.5.0 = work excellent
- darkradiant = doesnt work well
The .zip should work on Linux and MacOS, but the new Compiler doesnt work on both.

mfg nemNEMnem

UrTHD:Tools

2011-11-19T10:29:00Z

NemNEMnem: Created page with "=Compiler= ==FS_q3map_Radbump_4a== The FS_q3map_Radbump_4a is a special compiler for Bumpmapping, wich becomes a big point of mapping for UrTHD. Download: [http://www.mydevstuff...."

=Compiler=
==FS_q3map_Radbump_4a==
The FS_q3map_Radbump_4a is a special compiler for Bumpmapping, wich becomes a big point of mapping for UrTHD.
Download: [http://www.mydevstuff.com/twoseven/q3mods/ut_bumpy_pack.rar]
Forum: [http://www.urbanterror.info/forums/topic/26742-bumpmapping-modifications-enthusiastic-mappers-required]
=Other Tools=
==UrT Mapping Package 2.0==
Hi Guys,
The 2.0 Version of my Mapping Package is now out.

Download .exe: [http://nem.viper-project.de/wp-content/uploads/2011/11/urtmappingpackage2.0.exe]
Download .zip: [http://nem.viper-project.de/wp-content/uploads/2011/11/urtmappingpackage2.0.zip]

New:
- Added Urban Terror HDa for Radiant
- Added Urban Terror 4.2 for Radiant (for those who use the iourbanterror42_bumpy_v7a.exe)
- Updated Urban Terror 4.1.1
- Bump Mapping Support
- FS_q3map_Radbump_4-Builds included
- Buildcommands for FS_q3map_Radbump_4 in the Compiler
- Added the CubeMapProbe Entity
- Removed unused quake3 entities

Install .exe:

1. Start the Installer
2. Choose your Radiantinstallationfolder.
3. Install.

Install .zip:

1. Open the .zip-file with a zipprogramm (for example 7zip).
2. Extract all files in it to your Radiantinstallationfolder.

!!!YOU HAVE TO RESTART YOUR RADIANT AFTER THE INSTALLATION!!!

Thanks to:
TwentySeven for his great compiler and the coolest .exe ever.

Tested on:
- netradiant 1.5.0 = work excellent
- GtkRadiant 1.5.0 = work excellent
- darkradiant = doesnt work well
The .zip should work on Linux and MacOS, but the new Compiler doesnt work on both.

mfg nemNEMnem

Main Page

2011-11-19T10:20:55Z

NemNEMnem: /* Advanced */

__NOTOC__
== Introduction ==
Welcome to the '''Custom Map Makers wiki''' - a repository for all information relating to mapping for the popular first person shooter [http://www.urbanterror.info/ Urban Terror].

If you feel you'd like to contribute to this wiki, please email '''john@custommapmakers.org''' for more information.

The wiki is divided into the following sections, each of these contains further sub-topics. You can also search the wiki using the search box on the top.

== Beginning ==
{| cellspacing="5" width="100%"

|
{{RyMainPageBox|radiant.png|[[:Category:Radiant|Radiant]]|
* [[Radiant:MacRadiant|MacRadiant]]
* [[Radiant:ZeroRadiant|ZeroRadiant]]
* [[Radiant:NetRadiant|NetRadiant]]
* [[Radiant:Using|Using Radiant]]
* [[Radiant:Shortcuts_And_Menu_Options|Keyboard shortcuts/menu options]]
|HEIGHT=200px}}

|
{{RyMainPageBox|mapping.png|[[:Category:Mapping|Mapping]]|
* [[Mapping:Brushwork|Brushes]]
* [[Mapping:VIS|VIS]]
* [[Mapping:What is a patch|Patch Meshes]]
* [[:Category:Models|Models]]
* [[Mapping:Sky|Sky]]
* [[Mapping:Terrain|Terrain]]
* [[Compiling:Healthy_Map|Healthy Map]]
|HEIGHT=200px}}

|
{{RyMainPageBox|textures.png|[[:Category:Textures|Textures]]|
* [[Textures:Texturing|Texturing]]
* [[Textures:Shaders|Shaders]]
* [[Textures:Sites|Websites]]
* [[Textures:Formats|Formats]]
* [[Textures:Advanced Normal Maps Creation|Normal Maps]]
|HEIGHT=200px}}

|-

|
{{RyMainPageBox|lighting.png|[[:Category:Lighting|Lighting]]|
* [[Lighting:General|General]]
* [[Lighting:Leaks|Light leaks]]
* [[Lighting:Painting|Annoying FrankieV]]
* [[Lighting:Light Style|Light Style]]
|HEIGHT=176px}}

|
{{RyMainPageBox|entities.png|[[:Category:Entities|Entities]]|
* [[Entities:Func|func_*]]
* [[Entities:Info|info_*]]
* [[Entities:Target|target_*]]
* [[Entities:Trigger|trigger_*]]
* [[Entities:Misc|misc_*]]
* [[Entities:UT|ut_*]]
|HEIGHT=176px}}

|
{{RyMainPageBox|compiling.png|[[:Category:Compiling|Compiling]]|
* [[Compiling:q3map2|q3map2]]
* [[Compiling:Commands|Commands]]
* [[Compiling:Surface sounds|Surface sounds]]
* [[Compiling:Setup|Setup]]
* [[Compiling:Batch Files|Batch Files]]
* [[Compiling:Scripts|Scripts]]
|HEIGHT=176px}}

|}

== Advanced ==
{| cellspacing="5" width="100%"

|
{{RyMainPageBox|packaging.png|[[:Category:Packaging|Packaging]]|
* [[Packaging:Levelshot|Making a levelshot]]
* [[Packaging:Minimap|Making a minimap]]
* [[:Category:Packaging|Packaging]]
|HEIGHT=128px}}

|
{{RyMainPageBox|bots.png|[[:Category:Bots|Bots]]|
* [[Bots:Adding bots to your map|Adding bots]]
* [[Bots:Issues|Issues]]
* [[Bots:Advanced|Advanced topics]]
|HEIGHT=128px}}

|
{{RyMainPageBox|urt_hd.png|[[:Category:UrTHD|Urban Terror HD]]|
* [[UrTHD:Setup|Setup]]
* [[UrTHD:Tools]]
* [[UrTHD:Mapping|Mapping]]
|HEIGHT=128px}}

|
{{RyMainPageBox|layout.png|[[:Category:Layout|Layout]]|
* [[Layout:Level Design|Level design]]
* [[Layout:Bens Bible|Ben's small bible]]
|HEIGHT=128px}}

|}

== Further reading ==
{| cellspacing="5" width="100%"

|
{{RyMainPageBox|modelling.png|[[:Category:Models|Modelling]]|
* [[Models:Programs|Programs]]
* [[Models:Exporting|Exporting]]
* [[Models:Texturing|Texturing]]
* [[Models:Resources|Resources]]
|HEIGHT=176px}}

|
{{RyMainPageBox|resources.png|[[:Category:Resources|Resources]]|
* [[Resources:Tips|Tips and tricks]]
* [[:Category:Inspiration|Inspiration]]
* [[Resources:Tools|Tools]]
* [[Resources:Links|Links]]
* [[Sound:Websites|Sound websites]]
* [[IRC|CMM IRC Channel]]
|HEIGHT=176px}}

|
{{RyMainPageBox|funstuff.png|[[:Category:Funstuff|Funstuff]]|
* [[Funstuff:Creating|Creating]]
|HEIGHT=176px}}

|
{{RyMainPageBox|xreal.png|[[:Category:XreaL|XreaL]]|
* [[XreaL:About|About]]
* [[XreaL:Setup|Setup]]
* [[XreaL:Games|Games]]
|HEIGHT=176px}}
|}

Lighting:General

2011-09-03T11:26:18Z

NemNEMnem: Created page with "Light: General == How to add a light == Press the rightmousebutton on the 2D-window and choose "light", now there is a popup where you fill in your light-intensity. Its by defau..."

Light: General

== How to add a light ==
Press the rightmousebutton on the 2D-window and choose "light", now there is a popup where you fill in your light-intensity. Its by default 300.

''Warning: You have to compile your map with -light-option that you can see your light.''

== How to make a colored light ==
Choose the light, which you want to be color, and press "k", now choose your color and klick on "ok".

''Warning: You have to compile your map with -light-option that you can see your light.''

== How to create target light ==
Create a "target_position" and put it there where you want. Then press "esc" and choose your light, then choose your target_position and now press "shift+k"

''Warning: You have to compile your map with -light-option that you can see your light.''

Compiling:Commands

2011-08-21T09:57:12Z

NemNEMnem:

= Complete list of command line parameters =
== Common options ==
* -connect address: Talk to a NetRadiant instance using a specific XML based protocol
* -force: Allow reading some broken/unsupported BSP files e.g. when decompiling, may also crash
* -fs_basepath path: Sets the given path as main directory of the game (can be used more than once to look in multiple paths)
* -fs_game gamename: Sets a different game directory name (default for Q3A: baseq3)
* -fs_homebase dir: Specifies where the user home directory name is on Linux (default for Q3A: .q3a)
* -game gamename: Load settings for the given game (default: quake3)
* -subdivisions F: multiplier for patch subdivisions quality
* -threads N: number of threads to use
* -v: Verbose mode
== BSP stage ==
* -bsp ... filename.map: Switch that enters this stage
* -altsplit: Alternate BSP tree splitting weights (should give more fps)
* -celshader shadername: Sets a global cel shader name
* -custinfoparms: Read scripts/custinfoparms.txt
* -debuginset: Push all triangle vertexes towards the triangle center
* -debugportals: Make BSP portals visible in the map
* -debugsurfaces: Color the vertexes according to the index of the surface
* -deep: Use detail brushes in the BSP tree, but at lowest priority (should give more fps)
* -de F: Distance epsilon for plane snapping etc.
* -fakemap: Write fakemap.map containing all world brushes
* -flares: Turn on support for flares (TEST?)
* -flat: Enable flat shading (good for combining with -celshader)
* -fulldetail: Treat detail brushes as structural ones
* -leaktest: Abort if a leak was found
* -meta: Combine adjacent triangles of the same texture to surfaces (ALWAYS USE THIS)
* -minsamplesize N: Sets minimum lightmap resolution in luxels/qu
* -mi N: Sets the maximum number of indexes per surface
* -mv N: Sets the maximum number of vertices of a lightmapped surface
* -ne F: Normal epsilon for plane snapping etc.
* -nocurves: Turn off support for patches
* -nodetail: Leave out detail brushes
* -noflares: Turn off support for flares
* -nofog: Turn off support for fog volumes
* -nohint: Turn off support for hint brushes
* -nosubdivide: Turn off support for q3map_tessSize (breaks water vertex deforms)
* -notjunc: Do not fix T-junctions (causes cracks between triangles, do not use)
* -nowater: Turn off support for water, slime or lava (Stef, this is for you)
* -np A: Force all surfaces to be nonplanar with a given shade angle
* -onlyents: Only update entities in the BSP
* -patchmeta: Turn patches into triangle meshes for display
* -rename: Append "\_bsp" suffix to misc\_model shaders (needed for SoF2)
* -samplesize N: Sets default lightmap resolution in luxels/qu
* -skyfix: Turn sky box into six surfaces to work around ATI problems
* -snap N: Snap brush bevel planes to the given number of units
* -tempname filename.map: Read the MAP file from the given file name
* -texrange N: Limit per-surface texture range to the given number of units, and subdivide surfaces like with q3map_tessSize if this is not met
* -tmpout: Write the BSP file to /tmp
* -verboseentities: Enable -v only for map entities, not for the world
== VIS stage ==
* -vis ... filename.map: Switch that enters this stage
* -fast: Very fast and crude vis calculation
* -mergeportals: The less crude half of -merge, makes vis sometimes much faster but doesn't hurt fps usually
* -merge: Faster but still okay vis calculation
* -nopassage: Just use PortalFlow vis (usually less fps)
* -nosort: Do not sort the portals before calculating vis (usually slower)
* -passageOnly: Just use PassageFlow vis (usually less fps)
* -saveprt: Keep the PRT file after running vis (so you can run vis again)
* -tmpin: Use /tmp folder for input
* -tmpout: Use /tmp folder for output
== LIGHT stage ==
* -light ... filename.map: Switch that enters this stage
* -vlight ... filename.map: Deprecated alias for -light -fast ... filename.map
* -approx N: Vertex light approximation tolerance (never use in conjunction with deluxemapping)
* -areascale F, -area F: Scaling factor for area lights (surfacelight)
* -border: Add a red border to lightmaps for debugging
* -bouncegrid: Also compute radiosity on the light grid
* -bounceonly: Only compute radiosity
* -bouncescale F: Scaling factor for radiosity
* -bounce N: Number of bounces for radiosity
* -cheapgrid: Use -cheap style lighting for radiosity
* -cheap: Abort vertex light calculations when white is reached
* -compensate F: Lightmap compensate (darkening factor applied after everything else)
* -cpma: CPMA vertex lighting mode
* -custinfoparms: Read scripts/custinfoparms.txt
* -dark: Darken lightmap seams
* -debugaxis: Color the lightmaps according to the lightmap axis
* -debugcluster: Color the lightmaps according to the index of the cluster
* -debugdeluxe: Show deluxemaps on the lightmap
* -debugnormals: Color the lightmaps according to the direction of the surface normal
* -debugorigin: Color the lightmaps according to the origin of the luxels
* -debugsurfaces, -debugsurface: Color the lightmaps according to the index of the surface
* -debugunused: This option does nothing
* -debug: Mark the lightmaps according to the cluster: unmapped clusters get yellow, occluded ones get pink, flooded ones get blue overlay color, otherwise red
* -deluxemode 0: Use modelspace deluxemaps (DarkPlaces)
* -deluxemode 1: Use tangentspace deluxemaps
* -deluxe, -deluxemap: Enable deluxemapping (light direction maps)
* -dirtdebug, -debugdirt: Store the dirtmaps as lightmaps for debugging
* -dirtdepth: Dirtmapping depth
* -dirtgain: Dirtmapping exponent
* -dirtmode 0: Ordered direction dirtmapping
* -dirtmode 1: Randomized direction dirtmapping
* -dirtscale: Dirtmapping scaling factor
* -dirty: Enable dirtmapping
* -dump: Dump radiosity from -bounce into numbered MAP file prefabs
* -export: Export lightmaps when compile finished (like -export mode)
* -exposure F: Lightmap exposure to better support overbright spots
* -external: Force external lightmaps even if at size of internal lightmaps
* -extravisnudge: Broken feature to nudge the luxel origin to a better vis cluster
* -extrawide: Deprecated alias for -super 2 -filter
* -extra: Deprecated alias for -super 2
* -fastbounce: Use -fast style lighting for radiosity
* -faster: Use a faster falloff curve for lighting; also implies -fast
* -fastgrid: Use -fast style lighting for the light grid
* -fast: Ignore tiny light contributions
* -filter: Lightmap filtering
* -floodlight: Enable floodlight (zero-effort somewhat decent lighting)
* -gamma F: Lightmap gamma
* -gridambientscale F: Scaling factor for the light grid ambient components only
* -gridscale F: Scaling factor for the light grid only
* -keeplights: Keep light entities in the BSP file after compile
* -lightmapdir directory: Directory to store external lightmaps (default: same as map name without extension)
* -lightmapsize N: Size of lightmaps to generate (must be a power of two)
* -lomem: Low memory but slower lighting mode
* -lowquality: Low quality floodlight (appears to currently break floodlight)
* -minsamplesize N: Sets minimum lightmap resolution in luxels/qu
* -nocollapse: Do not collapse identical lightmaps
* -nodeluxe, -nodeluxemap: Disable deluxemapping
* -nogrid: Disable grid light calculation (makes all entities fullbright)
* -nolightmapsearch: Do not optimize lightmap packing for GPU memory usage (as doing so costs fps)
* -normalmap: Color the lightmaps according to the direction of the surface normal (TODO is this identical to -debugnormals?)
* -nostyle, -nostyles: Disable support for light styles
* -nosurf: Disable tracing against surfaces (only uses BSP nodes then)
* -notrace: Disable shadow occlusion
* -novertex: Disable vertex lighting
* -patchshadows: Cast shadows from patches
* -pointscale F, -point F: Scaling factor for point lights (light entities)
* -q3: Use nonlinear falloff curve by default (like Q3A)
* -samplescale F: Scales all lightmap resolutions
* -samplesize N: Sets default lightmap resolution in luxels/qu
* -samples N: Adaptive supersampling quality
* -scale F: Scaling factor for all light types
* -shadeangle A: Angle for phong shading
* -shade: Enable phong shading at default shade angle
* -skyscale F, -sky F: Scaling factor for sky and sun light
* -smooth: Deprecated alias for -samples 2
* -style, -styles: Enable support for light styles
* -sunonly: Only compute sun light
* -super N, -supersample N: Ordered grid supersampling quality
* -thresh F: Triangle subdivision threshold
* -trianglecheck: Broken check that should ensure luxels apply to the right triangle
* -trisoup: Convert brush faces to triangle soup
* -wolf: Use linear falloff curve by default (like W:ET)
== Analyzing BSP-like file structure ==
* -analyze ... filename.bsp: Switch that enters this mode
* -lumpswap: Swap byte order in the lumps
== Converting & Decompiling ==
* -convert ... filename.bsp: Switch that enters this mode
* -de number: Distance epsilon for the conversion
* -format converter: Select the converter (available: map, ase, or game names)
* -ne F: Normal epsilon for the conversion
* -shadersasbitmap: (only for ase) use the shader names as *BITMAP key so they work as prefabs
== Exporting lightmaps==
* -export filename.bsp: Copies lightmaps from the BSP to filename/lightmap_0000.tga ff
== Fixing AAS checksum ==
* -fixaas filename.bsp: Switch that enters this mode
== Get info about BSP file ==
* -info filename.bsp: Switch that enters this mode
== Importing lightmaps ==
* -import filename.bsp: Copies lightmaps from filename/lightmap_0000.tga ff into the BSP
== MiniMap ==
* -minimap ... filename.bsp: Creates a minimap of the BSP, by default writes to ../gfx/filename_mini.tga
* -black: Write the minimap as a black-on-transparency RGBA32 image
* -boost F: Sets the contrast boost value (higher values make a brighter image); contrast boost is somewhat similar to gamma, but continuous even at zero
* -border F: Sets the amount of border pixels relative to the total image size
* -gray: Write the minimap as a white-on-black GRAY8 image
* -keepaspect: Ensure the aspect ratio is kept (the minimap is then letterboxed to keep aspect)
* -minmax xmin ymin zmin xmax ymax zmax: Forces specific map dimensions (note: the minimap actually uses these dimensions, scaled to the target size while keeping aspect with * -centering, and 1/64 of border appended to all sides)
* -nokeepaspect: Do not ensure the aspect ratio is kept (makes it easier to use the image in your code, but looks bad together with sharpening)
* -o filename.tga: Sets the output file name
* -random N: Sets the randomized supersampling count (cannot be combined with -samples)
* -samples N: Sets the ordered supersampling count (cannot be combined with -random)
* -sharpen F: Sets the sharpening coefficient
* -size N: Sets the width and height of the output image
* -white: Write the minimap as a white-on-transparency RGBA32 image
== Scaling ==
* -scale S filename.bsp: Scale uniformly
* -scale SX SY SZ filename.bsp: Scale non-uniformly
* -scale -tex S filename.bsp: Scale uniformly without texture lock
* -scale -tex SX SY SZ filename.bsp: Scale non-uniformly without texture lock

Compiling:Commands

2011-08-21T09:54:02Z

NemNEMnem:

= Complete list of command line parameters =
== Common options ==
* connect address: Talk to a NetRadiant instance using a specific XML based protocol
* force: Allow reading some broken/unsupported BSP files e.g. when decompiling, may also crash
* fs_basepath path: Sets the given path as main directory of the game (can be used more than once to look in multiple paths)
* fs_game gamename: Sets a different game directory name (default for Q3A: baseq3)
* fs_homebase dir: Specifies where the user home directory name is on Linux (default for Q3A: .q3a)
* game gamename: Load settings for the given game (default: quake3)
* subdivisions F: multiplier for patch subdivisions quality
* threads N: number of threads to use
* v: Verbose mode
== BSP stage ==
* bsp ... filename.map: Switch that enters this stage
* altsplit: Alternate BSP tree splitting weights (should give more fps)
* celshader shadername: Sets a global cel shader name
* custinfoparms: Read scripts/custinfoparms.txt
* debuginset: Push all triangle vertexes towards the triangle center
* debugportals: Make BSP portals visible in the map
* debugsurfaces: Color the vertexes according to the index of the surface
* deep: Use detail brushes in the BSP tree, but at lowest priority (should give more fps)
* de F: Distance epsilon for plane snapping etc.
* fakemap: Write fakemap.map containing all world brushes
* flares: Turn on support for flares (TEST?)
* flat: Enable flat shading (good for combining with -celshader)
* fulldetail: Treat detail brushes as structural ones
* leaktest: Abort if a leak was found
* meta: Combine adjacent triangles of the same texture to surfaces (ALWAYS USE THIS)
* minsamplesize N: Sets minimum lightmap resolution in luxels/qu
* mi N: Sets the maximum number of indexes per surface
* mv N: Sets the maximum number of vertices of a lightmapped surface
* ne F: Normal epsilon for plane snapping etc.
* nocurves: Turn off support for patches
* nodetail: Leave out detail brushes
* noflares: Turn off support for flares
* nofog: Turn off support for fog volumes
* nohint: Turn off support for hint brushes
* nosubdivide: Turn off support for q3map_tessSize (breaks water vertex deforms)
* notjunc: Do not fix T-junctions (causes cracks between triangles, do not use)
* nowater: Turn off support for water, slime or lava (Stef, this is for you)
* np A: Force all surfaces to be nonplanar with a given shade angle
* onlyents: Only update entities in the BSP
* patchmeta: Turn patches into triangle meshes for display
* rename: Append "\_bsp" suffix to misc\_model shaders (needed for SoF2)
* samplesize N: Sets default lightmap resolution in luxels/qu
* skyfix: Turn sky box into six surfaces to work around ATI problems
* snap N: Snap brush bevel planes to the given number of units
* tempname filename.map: Read the MAP file from the given file name
* texrange N: Limit per-surface texture range to the given number of units, and subdivide surfaces like with q3map_tessSize if this is not met
* tmpout: Write the BSP file to /tmp
* verboseentities: Enable -v only for map entities, not for the world
== VIS stage ==
* vis ... filename.map: Switch that enters this stage
* fast: Very fast and crude vis calculation
* mergeportals: The less crude half of -merge, makes vis sometimes much faster but doesn't hurt fps usually
* merge: Faster but still okay vis calculation
* nopassage: Just use PortalFlow vis (usually less fps)
* nosort: Do not sort the portals before calculating vis (usually slower)
* passageOnly: Just use PassageFlow vis (usually less fps)
* saveprt: Keep the PRT file after running vis (so you can run vis again)
* tmpin: Use /tmp folder for input
* tmpout: Use /tmp folder for output
== LIGHT stage ==
* light ... filename.map: Switch that enters this stage
* vlight ... filename.map: Deprecated alias for -light -fast ... filename.map
* approx N: Vertex light approximation tolerance (never use in conjunction with deluxemapping)
* areascale F, -area F: Scaling factor for area lights (surfacelight)
* border: Add a red border to lightmaps for debugging
* bouncegrid: Also compute radiosity on the light grid
* bounceonly: Only compute radiosity
* bouncescale F: Scaling factor for radiosity
* bounce N: Number of bounces for radiosity
* cheapgrid: Use -cheap style lighting for radiosity
* cheap: Abort vertex light calculations when white is reached
* compensate F: Lightmap compensate (darkening factor applied after everything else)
* cpma: CPMA vertex lighting mode
* custinfoparms: Read scripts/custinfoparms.txt
* dark: Darken lightmap seams
* debugaxis: Color the lightmaps according to the lightmap axis
* debugcluster: Color the lightmaps according to the index of the cluster
* debugdeluxe: Show deluxemaps on the lightmap
* debugnormals: Color the lightmaps according to the direction of the surface normal
* debugorigin: Color the lightmaps according to the origin of the luxels
* debugsurfaces, -debugsurface: Color the lightmaps according to the index of the surface
* debugunused: This option does nothing
* debug: Mark the lightmaps according to the cluster: unmapped clusters get yellow, occluded ones get pink, flooded ones get blue overlay color, otherwise red
* deluxemode 0: Use modelspace deluxemaps (DarkPlaces)
* deluxemode 1: Use tangentspace deluxemaps
* deluxe, -deluxemap: Enable deluxemapping (light direction maps)
* dirtdebug, -debugdirt: Store the dirtmaps as lightmaps for debugging
* dirtdepth: Dirtmapping depth
* dirtgain: Dirtmapping exponent
* dirtmode 0: Ordered direction dirtmapping
* dirtmode 1: Randomized direction dirtmapping
* dirtscale: Dirtmapping scaling factor
* dirty: Enable dirtmapping
* dump: Dump radiosity from -bounce into numbered MAP file prefabs
* export: Export lightmaps when compile finished (like -export mode)
* exposure F: Lightmap exposure to better support overbright spots
* external: Force external lightmaps even if at size of internal lightmaps
* extravisnudge: Broken feature to nudge the luxel origin to a better vis cluster
* extrawide: Deprecated alias for -super 2 -filter
* extra: Deprecated alias for -super 2
* fastbounce: Use -fast style lighting for radiosity
* faster: Use a faster falloff curve for lighting; also implies -fast
* fastgrid: Use -fast style lighting for the light grid
* fast: Ignore tiny light contributions
* filter: Lightmap filtering
* floodlight: Enable floodlight (zero-effort somewhat decent lighting)
* gamma F: Lightmap gamma
* gridambientscale F: Scaling factor for the light grid ambient components only
* gridscale F: Scaling factor for the light grid only
* keeplights: Keep light entities in the BSP file after compile
* lightmapdir directory: Directory to store external lightmaps (default: same as map name without extension)
* lightmapsize N: Size of lightmaps to generate (must be a power of two)
* lomem: Low memory but slower lighting mode
* lowquality: Low quality floodlight (appears to currently break floodlight)
* minsamplesize N: Sets minimum lightmap resolution in luxels/qu
* nocollapse: Do not collapse identical lightmaps
* nodeluxe, -nodeluxemap: Disable deluxemapping
* nogrid: Disable grid light calculation (makes all entities fullbright)
* nolightmapsearch: Do not optimize lightmap packing for GPU memory usage (as doing so costs fps)
* normalmap: Color the lightmaps according to the direction of the surface normal (TODO is this identical to -debugnormals?)
* nostyle, -nostyles: Disable support for light styles
* nosurf: Disable tracing against surfaces (only uses BSP nodes then)
* notrace: Disable shadow occlusion
* novertex: Disable vertex lighting
* patchshadows: Cast shadows from patches
* pointscale F, -point F: Scaling factor for point lights (light entities)
* q3: Use nonlinear falloff curve by default (like Q3A)
* samplescale F: Scales all lightmap resolutions
* samplesize N: Sets default lightmap resolution in luxels/qu
* samples N: Adaptive supersampling quality
* scale F: Scaling factor for all light types
* shadeangle A: Angle for phong shading
* shade: Enable phong shading at default shade angle
* skyscale F, -sky F: Scaling factor for sky and sun light
* smooth: Deprecated alias for -samples 2
* style, -styles: Enable support for light styles
* sunonly: Only compute sun light
* super N, -supersample N: Ordered grid supersampling quality
* thresh F: Triangle subdivision threshold
* trianglecheck: Broken check that should ensure luxels apply to the right triangle
* trisoup: Convert brush faces to triangle soup
* wolf: Use linear falloff curve by default (like W:ET)
== Analyzing BSP-like file structure ==
* analyze ... filename.bsp: Switch that enters this mode
* lumpswap: Swap byte order in the lumps
== Converting & Decompiling ==
* convert ... filename.bsp: Switch that enters this mode
* de number: Distance epsilon for the conversion
* format converter: Select the converter (available: map, ase, or game names)
* ne F: Normal epsilon for the conversion
* shadersasbitmap: (only for ase) use the shader names as *BITMAP key so they work as prefabs
== Exporting lightmaps==
* export filename.bsp: Copies lightmaps from the BSP to filename/lightmap_0000.tga ff
== Fixing AAS checksum ==
* fixaas filename.bsp: Switch that enters this mode
== Get info about BSP file ==
* info filename.bsp: Switch that enters this mode
== Importing lightmaps ==
* import filename.bsp: Copies lightmaps from filename/lightmap_0000.tga ff into the BSP
== MiniMap ==
* minimap ... filename.bsp: Creates a minimap of the BSP, by default writes to ../gfx/filename_mini.tga
* black: Write the minimap as a black-on-transparency RGBA32 image
* boost F: Sets the contrast boost value (higher values make a brighter image); contrast boost is somewhat similar to gamma, but continuous even at zero
* border F: Sets the amount of border pixels relative to the total image size
* gray: Write the minimap as a white-on-black GRAY8 image
* keepaspect: Ensure the aspect ratio is kept (the minimap is then letterboxed to keep aspect)
* minmax xmin ymin zmin xmax ymax zmax: Forces specific map dimensions (note: the minimap actually uses these dimensions, scaled to the target size while keeping aspect with * centering, and 1/64 of border appended to all sides)
* nokeepaspect: Do not ensure the aspect ratio is kept (makes it easier to use the image in your code, but looks bad together with sharpening)
* o filename.tga: Sets the output file name
* random N: Sets the randomized supersampling count (cannot be combined with -samples)
* samples N: Sets the ordered supersampling count (cannot be combined with -random)
* sharpen F: Sets the sharpening coefficient
* size N: Sets the width and height of the output image
* white: Write the minimap as a white-on-transparency RGBA32 image
== Scaling ==
* scale S filename.bsp: Scale uniformly
* scale SX SY SZ filename.bsp: Scale non-uniformly
* scale -tex S filename.bsp: Scale uniformly without texture lock
* scale -tex SX SY SZ filename.bsp: Scale non-uniformly without texture lock

Compiling:Commands

2011-08-21T09:50:58Z

NemNEMnem:

= Complete list of command line parameters =
== Common options ==
* connect address: Talk to a NetRadiant instance using a specific XML based protocol
* force: Allow reading some broken/unsupported BSP files e.g. when decompiling, may also crash
* fs_basepath path: Sets the given path as main directory of the game (can be used more than once to look in multiple paths)
* fs_game gamename: Sets a different game directory name (default for Q3A: baseq3)
* fs_homebase dir: Specifies where the user home directory name is on Linux (default for Q3A: .q3a)
* game gamename: Load settings for the given game (default: quake3)
* subdivisions F: multiplier for patch subdivisions quality
* threads N: number of threads to use
* v: Verbose mode
== BSP stage ==
* bsp ... filename.map: Switch that enters this stage
* altsplit: Alternate BSP tree splitting weights (should give more fps)
* celshader shadername: Sets a global cel shader name
* custinfoparms: Read scripts/custinfoparms.txt
* debuginset: Push all triangle vertexes towards the triangle center
* debugportals: Make BSP portals visible in the map
* debugsurfaces: Color the vertexes according to the index of the surface
* deep: Use detail brushes in the BSP tree, but at lowest priority (should give more fps)
* de F: Distance epsilon for plane snapping etc.
* fakemap: Write fakemap.map containing all world brushes
* flares: Turn on support for flares (TEST?)
* flat: Enable flat shading (good for combining with -celshader)
* fulldetail: Treat detail brushes as structural ones
* leaktest: Abort if a leak was found
* meta: Combine adjacent triangles of the same texture to surfaces (ALWAYS USE THIS)
* minsamplesize N: Sets minimum lightmap resolution in luxels/qu
* mi N: Sets the maximum number of indexes per surface
* mv N: Sets the maximum number of vertices of a lightmapped surface
* ne F: Normal epsilon for plane snapping etc.
* nocurves: Turn off support for patches
* nodetail: Leave out detail brushes
* noflares: Turn off support for flares
* nofog: Turn off support for fog volumes
* nohint: Turn off support for hint brushes
* nosubdivide: Turn off support for q3map_tessSize (breaks water vertex deforms)
* notjunc: Do not fix T-junctions (causes cracks between triangles, do not use)
* nowater: Turn off support for water, slime or lava (Stef, this is for you)
* np A: Force all surfaces to be nonplanar with a given shade angle
* onlyents: Only update entities in the BSP
* patchmeta: Turn patches into triangle meshes for display
* rename: Append "\_bsp" suffix to misc\_model shaders (needed for SoF2)
* samplesize N: Sets default lightmap resolution in luxels/qu
* skyfix: Turn sky box into six surfaces to work around ATI problems
* snap N: Snap brush bevel planes to the given number of units
* tempname filename.map: Read the MAP file from the given file name
* texrange N: Limit per-surface texture range to the given number of units, and subdivide surfaces like with q3map_tessSize if this is not met
* tmpout: Write the BSP file to /tmp
* verboseentities: Enable -v only for map entities, not for the world
== VIS stage ==
* vis ... filename.map: Switch that enters this stage
* fast: Very fast and crude vis calculation
* mergeportals: The less crude half of -merge, makes vis sometimes much faster but doesn't hurt fps usually
* merge: Faster but still okay vis calculation
* nopassage: Just use PortalFlow vis (usually less fps)
* nosort: Do not sort the portals before calculating vis (usually slower)
* passageOnly: Just use PassageFlow vis (usually less fps)
* saveprt: Keep the PRT file after running vis (so you can run vis again)
* tmpin: Use /tmp folder for input
* tmpout: Use /tmp folder for output
== LIGHT stage ==
* light ... filename.map: Switch that enters this stage
* vlight ... filename.map: Deprecated alias for -light -fast ... filename.map
* approx N: Vertex light approximation tolerance (never use in conjunction with deluxemapping)
* areascale F, -area F: Scaling factor for area lights (surfacelight)
* border: Add a red border to lightmaps for debugging
* bouncegrid: Also compute radiosity on the light grid
* bounceonly: Only compute radiosity
* bouncescale F: Scaling factor for radiosity
* bounce N: Number of bounces for radiosity
* cheapgrid: Use -cheap style lighting for radiosity
* cheap: Abort vertex light calculations when white is reached
* compensate F: Lightmap compensate (darkening factor applied after everything else)
* cpma: CPMA vertex lighting mode
* custinfoparms: Read scripts/custinfoparms.txt
* dark: Darken lightmap seams
* debugaxis: Color the lightmaps according to the lightmap axis
* debugcluster: Color the lightmaps according to the index of the cluster
* debugdeluxe: Show deluxemaps on the lightmap
* debugnormals: Color the lightmaps according to the direction of the surface normal
* debugorigin: Color the lightmaps according to the origin of the luxels
* debugsurfaces, -debugsurface: Color the lightmaps according to the index of the surface
* debugunused: This option does nothing
* debug: Mark the lightmaps according to the cluster: unmapped clusters get yellow, occluded ones get pink, flooded ones get blue overlay color, otherwise red
* deluxemode 0: Use modelspace deluxemaps (DarkPlaces)
* deluxemode 1: Use tangentspace deluxemaps
* deluxe, -deluxemap: Enable deluxemapping (light direction maps)
* dirtdebug, -debugdirt: Store the dirtmaps as lightmaps for debugging
* dirtdepth: Dirtmapping depth
* dirtgain: Dirtmapping exponent
* dirtmode 0: Ordered direction dirtmapping
* dirtmode 1: Randomized direction dirtmapping
* dirtscale: Dirtmapping scaling factor
* dirty: Enable dirtmapping
* dump: Dump radiosity from -bounce into numbered MAP file prefabs
* export: Export lightmaps when compile finished (like -export mode)
* exposure F: Lightmap exposure to better support overbright spots
* external: Force external lightmaps even if at size of internal lightmaps
* extravisnudge: Broken feature to nudge the luxel origin to a better vis cluster
* extrawide: Deprecated alias for -super 2 -filter
* extra: Deprecated alias for -super 2
* fastbounce: Use -fast style lighting for radiosity
* faster: Use a faster falloff curve for lighting; also implies -fast
* fastgrid: Use -fast style lighting for the light grid
* fast: Ignore tiny light contributions
* filter: Lightmap filtering
* floodlight: Enable floodlight (zero-effort somewhat decent lighting)
* gamma F: Lightmap gamma
* gridambientscale F: Scaling factor for the light grid ambient components only
* gridscale F: Scaling factor for the light grid only
* keeplights: Keep light entities in the BSP file after compile
* lightmapdir directory: Directory to store external lightmaps (default: same as map name without extension)
* lightmapsize N: Size of lightmaps to generate (must be a power of two)
* lomem: Low memory but slower lighting mode
* lowquality: Low quality floodlight (appears to currently break floodlight)
* minsamplesize N: Sets minimum lightmap resolution in luxels/qu
* nocollapse: Do not collapse identical lightmaps
* nodeluxe, -nodeluxemap: Disable deluxemapping
* nogrid: Disable grid light calculation (makes all entities fullbright)
* nolightmapsearch: Do not optimize lightmap packing for GPU memory usage (as doing so costs fps)
* normalmap: Color the lightmaps according to the direction of the surface normal (TODO is this identical to -debugnormals?)
* nostyle, -nostyles: Disable support for light styles
* nosurf: Disable tracing against surfaces (only uses BSP nodes then)
* notrace: Disable shadow occlusion
* novertex: Disable vertex lighting
* patchshadows: Cast shadows from patches
* pointscale F, -point F: Scaling factor for point lights (light entities)
* q3: Use nonlinear falloff curve by default (like Q3A)
* samplescale F: Scales all lightmap resolutions
* samplesize N: Sets default lightmap resolution in luxels/qu
* samples N: Adaptive supersampling quality
* scale F: Scaling factor for all light types
* shadeangle A: Angle for phong shading
* shade: Enable phong shading at default shade angle
* skyscale F, -sky F: Scaling factor for sky and sun light
* smooth: Deprecated alias for -samples 2
* style, -styles: Enable support for light styles
* sunonly: Only compute sun light
* super N, -supersample N: Ordered grid supersampling quality
* thresh F: Triangle subdivision threshold
* trianglecheck: Broken check that should ensure luxels apply to the right triangle
* trisoup: Convert brush faces to triangle soup
* wolf: Use linear falloff curve by default (like W:ET)
== Analyzing BSP-like file structure ==
-analyze ... filename.bsp: Switch that enters this mode
-lumpswap: Swap byte order in the lumps
Converting & Decompiling
-convert ... filename.bsp: Switch that enters this mode
-de number: Distance epsilon for the conversion
-format converter: Select the converter (available: map, ase, or game names)
-ne F: Normal epsilon for the conversion
-shadersasbitmap: (only for ase) use the shader names as *BITMAP key so they work as prefabs
Exporting lightmaps
-export filename.bsp: Copies lightmaps from the BSP to filename/lightmap_0000.tga ff
Fixing AAS checksum
-fixaas filename.bsp: Switch that enters this mode
Get info about BSP file
-info filename.bsp: Switch that enters this mode
Importing lightmaps
-import filename.bsp: Copies lightmaps from filename/lightmap_0000.tga ff into the BSP
== MiniMap ==
-minimap ... filename.bsp: Creates a minimap of the BSP, by default writes to ../gfx/filename_mini.tga
-black: Write the minimap as a black-on-transparency RGBA32 image
-boost F: Sets the contrast boost value (higher values make a brighter image); contrast boost is somewhat similar to gamma, but continuous even at zero
-border F: Sets the amount of border pixels relative to the total image size
-gray: Write the minimap as a white-on-black GRAY8 image
-keepaspect: Ensure the aspect ratio is kept (the minimap is then letterboxed to keep aspect)
-minmax xmin ymin zmin xmax ymax zmax: Forces specific map dimensions (note: the minimap actually uses these dimensions, scaled to the target size while keeping aspect with centering, and 1/64 of border appended to all sides)
-nokeepaspect: Do not ensure the aspect ratio is kept (makes it easier to use the image in your code, but looks bad together with sharpening)
-o filename.tga: Sets the output file name
-random N: Sets the randomized supersampling count (cannot be combined with -samples)
-samples N: Sets the ordered supersampling count (cannot be combined with -random)
-sharpen F: Sets the sharpening coefficient
-size N: Sets the width and height of the output image
-white: Write the minimap as a white-on-transparency RGBA32 image
== Scaling ==
-scale S filename.bsp: Scale uniformly
-scale SX SY SZ filename.bsp: Scale non-uniformly
-scale -tex S filename.bsp: Scale uniformly without texture lock
-scale -tex SX SY SZ filename.bsp: Scale non-uniformly without texture lock

Compiling:Commands

2011-08-21T09:46:42Z

NemNEMnem:

= Complete list of command line parameters =
== Common options ==
* connect address: Talk to a NetRadiant instance using a specific XML based protocol
* force: Allow reading some broken/unsupported BSP files e.g. when decompiling, may also crash
* fs_basepath path: Sets the given path as main directory of the game (can be used more than once to look in multiple paths)
* fs_game gamename: Sets a different game directory name (default for Q3A: baseq3)
* fs_homebase dir: Specifies where the user home directory name is on Linux (default for Q3A: .q3a)
* game gamename: Load settings for the given game (default: quake3)
* subdivisions F: multiplier for patch subdivisions quality
* threads N: number of threads to use
* v: Verbose mode
== BSP stage ==
* bsp ... filename.map: Switch that enters this stage
* altsplit: Alternate BSP tree splitting weights (should give more fps)
* celshader shadername: Sets a global cel shader name
* custinfoparms: Read scripts/custinfoparms.txt
* debuginset: Push all triangle vertexes towards the triangle center
* debugportals: Make BSP portals visible in the map
* debugsurfaces: Color the vertexes according to the index of the surface
* deep: Use detail brushes in the BSP tree, but at lowest priority (should give more fps)
* de F: Distance epsilon for plane snapping etc.
* fakemap: Write fakemap.map containing all world brushes
* flares: Turn on support for flares (TEST?)
* flat: Enable flat shading (good for combining with -celshader)
* fulldetail: Treat detail brushes as structural ones
* leaktest: Abort if a leak was found
* meta: Combine adjacent triangles of the same texture to surfaces (ALWAYS USE THIS)
* minsamplesize N: Sets minimum lightmap resolution in luxels/qu
* mi N: Sets the maximum number of indexes per surface
* mv N: Sets the maximum number of vertices of a lightmapped surface
* ne F: Normal epsilon for plane snapping etc.
* nocurves: Turn off support for patches
* nodetail: Leave out detail brushes
* noflares: Turn off support for flares
* nofog: Turn off support for fog volumes
* nohint: Turn off support for hint brushes
* nosubdivide: Turn off support for q3map_tessSize (breaks water vertex deforms)
* notjunc: Do not fix T-junctions (causes cracks between triangles, do not use)
* nowater: Turn off support for water, slime or lava (Stef, this is for you)
* np A: Force all surfaces to be nonplanar with a given shade angle
* onlyents: Only update entities in the BSP
* patchmeta: Turn patches into triangle meshes for display
* rename: Append "\_bsp" suffix to misc\_model shaders (needed for SoF2)
* samplesize N: Sets default lightmap resolution in luxels/qu
* skyfix: Turn sky box into six surfaces to work around ATI problems
* snap N: Snap brush bevel planes to the given number of units
* tempname filename.map: Read the MAP file from the given file name
* texrange N: Limit per-surface texture range to the given number of units, and subdivide surfaces like with q3map_tessSize if this is not met
* tmpout: Write the BSP file to /tmp
* verboseentities: Enable -v only for map entities, not for the world
== VIS stage ==
-vis ... filename.map: Switch that enters this stage
-fast: Very fast and crude vis calculation
-mergeportals: The less crude half of -merge, makes vis sometimes much faster but doesn't hurt fps usually
-merge: Faster but still okay vis calculation
-nopassage: Just use PortalFlow vis (usually less fps)
-nosort: Do not sort the portals before calculating vis (usually slower)
-passageOnly: Just use PassageFlow vis (usually less fps)
-saveprt: Keep the PRT file after running vis (so you can run vis again)
-tmpin: Use /tmp folder for input
-tmpout: Use /tmp folder for output
== LIGHT stage ==
-light ... filename.map: Switch that enters this stage
-vlight ... filename.map: Deprecated alias for -light -fast ... filename.map
-approx N: Vertex light approximation tolerance (never use in conjunction with deluxemapping)
-areascale F, -area F: Scaling factor for area lights (surfacelight)
-border: Add a red border to lightmaps for debugging
-bouncegrid: Also compute radiosity on the light grid
-bounceonly: Only compute radiosity
-bouncescale F: Scaling factor for radiosity
-bounce N: Number of bounces for radiosity
-cheapgrid: Use -cheap style lighting for radiosity
-cheap: Abort vertex light calculations when white is reached
-compensate F: Lightmap compensate (darkening factor applied after everything else)
-cpma: CPMA vertex lighting mode
-custinfoparms: Read scripts/custinfoparms.txt
-dark: Darken lightmap seams
-debugaxis: Color the lightmaps according to the lightmap axis
-debugcluster: Color the lightmaps according to the index of the cluster
-debugdeluxe: Show deluxemaps on the lightmap
-debugnormals: Color the lightmaps according to the direction of the surface normal
-debugorigin: Color the lightmaps according to the origin of the luxels
-debugsurfaces, -debugsurface: Color the lightmaps according to the index of the surface
-debugunused: This option does nothing
-debug: Mark the lightmaps according to the cluster: unmapped clusters get yellow, occluded ones get pink, flooded ones get blue overlay color, otherwise red
-deluxemode 0: Use modelspace deluxemaps (DarkPlaces)
-deluxemode 1: Use tangentspace deluxemaps
-deluxe, -deluxemap: Enable deluxemapping (light direction maps)
-dirtdebug, -debugdirt: Store the dirtmaps as lightmaps for debugging
-dirtdepth: Dirtmapping depth
-dirtgain: Dirtmapping exponent
-dirtmode 0: Ordered direction dirtmapping
-dirtmode 1: Randomized direction dirtmapping
-dirtscale: Dirtmapping scaling factor
-dirty: Enable dirtmapping
-dump: Dump radiosity from -bounce into numbered MAP file prefabs
-export: Export lightmaps when compile finished (like -export mode)
-exposure F: Lightmap exposure to better support overbright spots
-external: Force external lightmaps even if at size of internal lightmaps
-extravisnudge: Broken feature to nudge the luxel origin to a better vis cluster
-extrawide: Deprecated alias for -super 2 -filter
-extra: Deprecated alias for -super 2
-fastbounce: Use -fast style lighting for radiosity
-faster: Use a faster falloff curve for lighting; also implies -fast
-fastgrid: Use -fast style lighting for the light grid
-fast: Ignore tiny light contributions
-filter: Lightmap filtering
-floodlight: Enable floodlight (zero-effort somewhat decent lighting)
-gamma F: Lightmap gamma
-gridambientscale F: Scaling factor for the light grid ambient components only
-gridscale F: Scaling factor for the light grid only
-keeplights: Keep light entities in the BSP file after compile
-lightmapdir directory: Directory to store external lightmaps (default: same as map name without extension)
-lightmapsize N: Size of lightmaps to generate (must be a power of two)
-lomem: Low memory but slower lighting mode
-lowquality: Low quality floodlight (appears to currently break floodlight)
-minsamplesize N: Sets minimum lightmap resolution in luxels/qu
-nocollapse: Do not collapse identical lightmaps
-nodeluxe, -nodeluxemap: Disable deluxemapping
-nogrid: Disable grid light calculation (makes all entities fullbright)
-nolightmapsearch: Do not optimize lightmap packing for GPU memory usage (as doing so costs fps)
-normalmap: Color the lightmaps according to the direction of the surface normal (TODO is this identical to -debugnormals?)
-nostyle, -nostyles: Disable support for light styles
-nosurf: Disable tracing against surfaces (only uses BSP nodes then)
-notrace: Disable shadow occlusion
-novertex: Disable vertex lighting
-patchshadows: Cast shadows from patches
-pointscale F, -point F: Scaling factor for point lights (light entities)
-q3: Use nonlinear falloff curve by default (like Q3A)
-samplescale F: Scales all lightmap resolutions
-samplesize N: Sets default lightmap resolution in luxels/qu
-samples N: Adaptive supersampling quality
-scale F: Scaling factor for all light types
-shadeangle A: Angle for phong shading
-shade: Enable phong shading at default shade angle
-skyscale F, -sky F: Scaling factor for sky and sun light
-smooth: Deprecated alias for -samples 2
-style, -styles: Enable support for light styles
-sunonly: Only compute sun light
-super N, -supersample N: Ordered grid supersampling quality
-thresh F: Triangle subdivision threshold
-trianglecheck: Broken check that should ensure luxels apply to the right triangle
-trisoup: Convert brush faces to triangle soup
-wolf: Use linear falloff curve by default (like W:ET)
Analyzing BSP-like file structure
-analyze ... filename.bsp: Switch that enters this mode
-lumpswap: Swap byte order in the lumps
Converting & Decompiling
-convert ... filename.bsp: Switch that enters this mode
-de number: Distance epsilon for the conversion
-format converter: Select the converter (available: map, ase, or game names)
-ne F: Normal epsilon for the conversion
-shadersasbitmap: (only for ase) use the shader names as *BITMAP key so they work as prefabs
Exporting lightmaps
-export filename.bsp: Copies lightmaps from the BSP to filename/lightmap_0000.tga ff
Fixing AAS checksum
-fixaas filename.bsp: Switch that enters this mode
Get info about BSP file
-info filename.bsp: Switch that enters this mode
Importing lightmaps
-import filename.bsp: Copies lightmaps from filename/lightmap_0000.tga ff into the BSP
== MiniMap ==
-minimap ... filename.bsp: Creates a minimap of the BSP, by default writes to ../gfx/filename_mini.tga
-black: Write the minimap as a black-on-transparency RGBA32 image
-boost F: Sets the contrast boost value (higher values make a brighter image); contrast boost is somewhat similar to gamma, but continuous even at zero
-border F: Sets the amount of border pixels relative to the total image size
-gray: Write the minimap as a white-on-black GRAY8 image
-keepaspect: Ensure the aspect ratio is kept (the minimap is then letterboxed to keep aspect)
-minmax xmin ymin zmin xmax ymax zmax: Forces specific map dimensions (note: the minimap actually uses these dimensions, scaled to the target size while keeping aspect with centering, and 1/64 of border appended to all sides)
-nokeepaspect: Do not ensure the aspect ratio is kept (makes it easier to use the image in your code, but looks bad together with sharpening)
-o filename.tga: Sets the output file name
-random N: Sets the randomized supersampling count (cannot be combined with -samples)
-samples N: Sets the ordered supersampling count (cannot be combined with -random)
-sharpen F: Sets the sharpening coefficient
-size N: Sets the width and height of the output image
-white: Write the minimap as a white-on-transparency RGBA32 image
== Scaling ==
-scale S filename.bsp: Scale uniformly
-scale SX SY SZ filename.bsp: Scale non-uniformly
-scale -tex S filename.bsp: Scale uniformly without texture lock
-scale -tex SX SY SZ filename.bsp: Scale non-uniformly without texture lock

Compiling:Commands

2011-08-21T09:43:35Z

NemNEMnem: Created page with "= Complete list of command line parameters = == Common options == -connect address: Talk to a NetRadiant instance using a specific XML based protocol -force: Allow reading some b..."

= Complete list of command line parameters =
== Common options ==
-connect address: Talk to a NetRadiant instance using a specific XML based protocol
-force: Allow reading some broken/unsupported BSP files e.g. when decompiling, may also crash
-fs_basepath path: Sets the given path as main directory of the game (can be used more than once to look in multiple paths)
-fs_game gamename: Sets a different game directory name (default for Q3A: baseq3)
-fs_homebase dir: Specifies where the user home directory name is on Linux (default for Q3A: .q3a)
-game gamename: Load settings for the given game (default: quake3)
-subdivisions F: multiplier for patch subdivisions quality
-threads N: number of threads to use
-v: Verbose mode
== BSP stage ==
-bsp ... filename.map: Switch that enters this stage
-altsplit: Alternate BSP tree splitting weights (should give more fps)
-celshader shadername: Sets a global cel shader name
-custinfoparms: Read scripts/custinfoparms.txt
-debuginset: Push all triangle vertexes towards the triangle center
-debugportals: Make BSP portals visible in the map
-debugsurfaces: Color the vertexes according to the index of the surface
-deep: Use detail brushes in the BSP tree, but at lowest priority (should give more fps)
-de F: Distance epsilon for plane snapping etc.
-fakemap: Write fakemap.map containing all world brushes
-flares: Turn on support for flares (TEST?)
-flat: Enable flat shading (good for combining with -celshader)
-fulldetail: Treat detail brushes as structural ones
-leaktest: Abort if a leak was found
-meta: Combine adjacent triangles of the same texture to surfaces (ALWAYS USE THIS)
-minsamplesize N: Sets minimum lightmap resolution in luxels/qu
-mi N: Sets the maximum number of indexes per surface
-mv N: Sets the maximum number of vertices of a lightmapped surface
-ne F: Normal epsilon for plane snapping etc.
-nocurves: Turn off support for patches
-nodetail: Leave out detail brushes
-noflares: Turn off support for flares
-nofog: Turn off support for fog volumes
-nohint: Turn off support for hint brushes
-nosubdivide: Turn off support for q3map_tessSize (breaks water vertex deforms)
-notjunc: Do not fix T-junctions (causes cracks between triangles, do not use)
-nowater: Turn off support for water, slime or lava (Stef, this is for you)
-np A: Force all surfaces to be nonplanar with a given shade angle
-onlyents: Only update entities in the BSP
-patchmeta: Turn patches into triangle meshes for display
-rename: Append "\_bsp" suffix to misc\_model shaders (needed for SoF2)
-samplesize N: Sets default lightmap resolution in luxels/qu
-skyfix: Turn sky box into six surfaces to work around ATI problems
-snap N: Snap brush bevel planes to the given number of units
-tempname filename.map: Read the MAP file from the given file name
-texrange N: Limit per-surface texture range to the given number of units, and subdivide surfaces like with q3map_tessSize if this is not met
-tmpout: Write the BSP file to /tmp
-verboseentities: Enable -v only for map entities, not for the world
== VIS stage ==
-vis ... filename.map: Switch that enters this stage
-fast: Very fast and crude vis calculation
-mergeportals: The less crude half of -merge, makes vis sometimes much faster but doesn't hurt fps usually
-merge: Faster but still okay vis calculation
-nopassage: Just use PortalFlow vis (usually less fps)
-nosort: Do not sort the portals before calculating vis (usually slower)
-passageOnly: Just use PassageFlow vis (usually less fps)
-saveprt: Keep the PRT file after running vis (so you can run vis again)
-tmpin: Use /tmp folder for input
-tmpout: Use /tmp folder for output
== LIGHT stage ==
-light ... filename.map: Switch that enters this stage
-vlight ... filename.map: Deprecated alias for -light -fast ... filename.map
-approx N: Vertex light approximation tolerance (never use in conjunction with deluxemapping)
-areascale F, -area F: Scaling factor for area lights (surfacelight)
-border: Add a red border to lightmaps for debugging
-bouncegrid: Also compute radiosity on the light grid
-bounceonly: Only compute radiosity
-bouncescale F: Scaling factor for radiosity
-bounce N: Number of bounces for radiosity
-cheapgrid: Use -cheap style lighting for radiosity
-cheap: Abort vertex light calculations when white is reached
-compensate F: Lightmap compensate (darkening factor applied after everything else)
-cpma: CPMA vertex lighting mode
-custinfoparms: Read scripts/custinfoparms.txt
-dark: Darken lightmap seams
-debugaxis: Color the lightmaps according to the lightmap axis
-debugcluster: Color the lightmaps according to the index of the cluster
-debugdeluxe: Show deluxemaps on the lightmap
-debugnormals: Color the lightmaps according to the direction of the surface normal
-debugorigin: Color the lightmaps according to the origin of the luxels
-debugsurfaces, -debugsurface: Color the lightmaps according to the index of the surface
-debugunused: This option does nothing
-debug: Mark the lightmaps according to the cluster: unmapped clusters get yellow, occluded ones get pink, flooded ones get blue overlay color, otherwise red
-deluxemode 0: Use modelspace deluxemaps (DarkPlaces)
-deluxemode 1: Use tangentspace deluxemaps
-deluxe, -deluxemap: Enable deluxemapping (light direction maps)
-dirtdebug, -debugdirt: Store the dirtmaps as lightmaps for debugging
-dirtdepth: Dirtmapping depth
-dirtgain: Dirtmapping exponent
-dirtmode 0: Ordered direction dirtmapping
-dirtmode 1: Randomized direction dirtmapping
-dirtscale: Dirtmapping scaling factor
-dirty: Enable dirtmapping
-dump: Dump radiosity from -bounce into numbered MAP file prefabs
-export: Export lightmaps when compile finished (like -export mode)
-exposure F: Lightmap exposure to better support overbright spots
-external: Force external lightmaps even if at size of internal lightmaps
-extravisnudge: Broken feature to nudge the luxel origin to a better vis cluster
-extrawide: Deprecated alias for -super 2 -filter
-extra: Deprecated alias for -super 2
-fastbounce: Use -fast style lighting for radiosity
-faster: Use a faster falloff curve for lighting; also implies -fast
-fastgrid: Use -fast style lighting for the light grid
-fast: Ignore tiny light contributions
-filter: Lightmap filtering
-floodlight: Enable floodlight (zero-effort somewhat decent lighting)
-gamma F: Lightmap gamma
-gridambientscale F: Scaling factor for the light grid ambient components only
-gridscale F: Scaling factor for the light grid only
-keeplights: Keep light entities in the BSP file after compile
-lightmapdir directory: Directory to store external lightmaps (default: same as map name without extension)
-lightmapsize N: Size of lightmaps to generate (must be a power of two)
-lomem: Low memory but slower lighting mode
-lowquality: Low quality floodlight (appears to currently break floodlight)
-minsamplesize N: Sets minimum lightmap resolution in luxels/qu
-nocollapse: Do not collapse identical lightmaps
-nodeluxe, -nodeluxemap: Disable deluxemapping
-nogrid: Disable grid light calculation (makes all entities fullbright)
-nolightmapsearch: Do not optimize lightmap packing for GPU memory usage (as doing so costs fps)
-normalmap: Color the lightmaps according to the direction of the surface normal (TODO is this identical to -debugnormals?)
-nostyle, -nostyles: Disable support for light styles
-nosurf: Disable tracing against surfaces (only uses BSP nodes then)
-notrace: Disable shadow occlusion
-novertex: Disable vertex lighting
-patchshadows: Cast shadows from patches
-pointscale F, -point F: Scaling factor for point lights (light entities)
-q3: Use nonlinear falloff curve by default (like Q3A)
-samplescale F: Scales all lightmap resolutions
-samplesize N: Sets default lightmap resolution in luxels/qu
-samples N: Adaptive supersampling quality
-scale F: Scaling factor for all light types
-shadeangle A: Angle for phong shading
-shade: Enable phong shading at default shade angle
-skyscale F, -sky F: Scaling factor for sky and sun light
-smooth: Deprecated alias for -samples 2
-style, -styles: Enable support for light styles
-sunonly: Only compute sun light
-super N, -supersample N: Ordered grid supersampling quality
-thresh F: Triangle subdivision threshold
-trianglecheck: Broken check that should ensure luxels apply to the right triangle
-trisoup: Convert brush faces to triangle soup
-wolf: Use linear falloff curve by default (like W:ET)
Analyzing BSP-like file structure
-analyze ... filename.bsp: Switch that enters this mode
-lumpswap: Swap byte order in the lumps
Converting & Decompiling
-convert ... filename.bsp: Switch that enters this mode
-de number: Distance epsilon for the conversion
-format converter: Select the converter (available: map, ase, or game names)
-ne F: Normal epsilon for the conversion
-shadersasbitmap: (only for ase) use the shader names as *BITMAP key so they work as prefabs
Exporting lightmaps
-export filename.bsp: Copies lightmaps from the BSP to filename/lightmap_0000.tga ff
Fixing AAS checksum
-fixaas filename.bsp: Switch that enters this mode
Get info about BSP file
-info filename.bsp: Switch that enters this mode
Importing lightmaps
-import filename.bsp: Copies lightmaps from filename/lightmap_0000.tga ff into the BSP
== MiniMap ==
-minimap ... filename.bsp: Creates a minimap of the BSP, by default writes to ../gfx/filename_mini.tga
-black: Write the minimap as a black-on-transparency RGBA32 image
-boost F: Sets the contrast boost value (higher values make a brighter image); contrast boost is somewhat similar to gamma, but continuous even at zero
-border F: Sets the amount of border pixels relative to the total image size
-gray: Write the minimap as a white-on-black GRAY8 image
-keepaspect: Ensure the aspect ratio is kept (the minimap is then letterboxed to keep aspect)
-minmax xmin ymin zmin xmax ymax zmax: Forces specific map dimensions (note: the minimap actually uses these dimensions, scaled to the target size while keeping aspect with centering, and 1/64 of border appended to all sides)
-nokeepaspect: Do not ensure the aspect ratio is kept (makes it easier to use the image in your code, but looks bad together with sharpening)
-o filename.tga: Sets the output file name
-random N: Sets the randomized supersampling count (cannot be combined with -samples)
-samples N: Sets the ordered supersampling count (cannot be combined with -random)
-sharpen F: Sets the sharpening coefficient
-size N: Sets the width and height of the output image
-white: Write the minimap as a white-on-transparency RGBA32 image
== Scaling ==
-scale S filename.bsp: Scale uniformly
-scale SX SY SZ filename.bsp: Scale non-uniformly
-scale -tex S filename.bsp: Scale uniformly without texture lock
-scale -tex SX SY SZ filename.bsp: Scale non-uniformly without texture lock

Main Page

2011-08-21T09:41:31Z

NemNEMnem: /* Beginning */

__NOTOC__
== Introduction ==
Welcome to the '''Custom Map Makers wiki''' - a repository for all information relating to mapping for the popular first person shooter [http://www.urbanterror.info/ Urban Terror].

If you feel you'd like to contribute to this wiki, please email '''john@custommapmakers.org''' for more information.

The wiki is divided into the following sections, each of these contains further sub-topics. You can also search the wiki using the search box on the top.

== Beginning ==
{| cellspacing="5" width="100%"

|
{{RyMainPageBox|radiant.png|[[:Category:Radiant|Radiant]]|
* [[Radiant:MacRadiant|MacRadiant]]
* [[Radiant:ZeroRadiant|ZeroRadiant]]
* [[Radiant:NetRadiant|NetRadiant]]
* [[Radiant:Shortcuts|Keyboard shortcuts]]
* [[Radiant:Using|Using Radiant]]
|HEIGHT=176px}}

|
{{RyMainPageBox|mapping.png|[[:Category:Mapping|Mapping]]|
* [[Mapping:Brushwork|Brushes]]
* [[Mapping:VIS|VIS]]
* [[Mapping:Patch meshes|Patch Meshes]]
* [[Mapping:Models|Models]]
* [[Mapping:Sky|Sky]]
* [[Mapping:Terrain|Terrain]]
|HEIGHT=176px}}

|
{{RyMainPageBox|textures.png|[[:Category:Textures|Textures]]|
* [[Textures:Texturing|Texturing]]
* [[Textures:Shaders|Shaders]]
* [[Textures:Sites|Websites]]
* [[Textures:Formats|Formats]]
* [[Textures:Advanced Normal Maps Creation|Normal Maps]]
|HEIGHT=176px}}

|-

|
{{RyMainPageBox|lighting.png|[[:Category:Lighting|Lighting]]|
* [[Lighting:General|General]]
* [[Lighting:Leaks|Light leaks]]
* [[Lighting:Painting|Annoying FrankieV]]
* [[Lighting:Light Style|Light Style]]
|HEIGHT=176px}}

|
{{RyMainPageBox|entities.png|[[:Category:Entities|Entities]]|
* [[Entities:Func|func_*]]
* [[Entities:Info|info_*]]
* [[Entities:Target|target_*]]
* [[Entities:Trigger|trigger_*]]
* [[Entities:Misc|misc_*]]
* [[Entities:UT|ut_*]]
|HEIGHT=176px}}

|
{{RyMainPageBox|compiling.png|[[:Category:Compiling|Compiling]]|
* [[Compiling:q3map2|q3map2]]
* [[Compiling:Commands|Commands]]
* [[Compiling:Surface sounds|Surface sounds]]
* [[Compiling:Setup|Setup]]
* [[Compiling:Batch Files|Batch Files]]
* [[Compiling:Scripts|Scripts]]
|HEIGHT=176px}}

|}

== Advanced ==
{| cellspacing="5" width="100%"

|
{{RyMainPageBox|packaging.png|[[:Category:Packaging|Packaging]]|
* [[Packaging:Levelshot|Making a levelshot]]
* [[Packaging:Minimap|Making a minimap]]
* [[:Category:Packaging|Packaging]]
|HEIGHT=128px}}

|
{{RyMainPageBox|bots.png|[[:Category:Bots|Bots]]|
* [[Bots:Adding bots to your map|Adding bots]]
* [[Bots:Issues|Issues]]
* [[Bots:Advanced|Advanced topics]]
|HEIGHT=128px}}

|
{{RyMainPageBox|urt_hd.png|[[:Category:UrTHD|Urban Terror HD]]|
* [[UrTHD:Setup|Setup]]
* [[UrTHD:Mapping|Mapping]]
|HEIGHT=128px}}

|
{{RyMainPageBox|layout.png|[[:Category:Layout|Layout]]|
* [[Layout:Bens Bible|Ben's small bible]]
|HEIGHT=128px}}

|}
== Further reading ==
{| cellspacing="5" width="100%"

|
{{RyMainPageBox|modelling.png|[[:Category:Models|Modelling]]|
* [[Models:Programs|Programs]]
* [[Models:Exporting|Exporting]]
* [[Models:Texturing|Texturing]]
* [[Models:Resources|Resouces]]
|HEIGHT=144px}}

|
{{RyMainPageBox|resources.png|[[:Category:Resources|Resources]]|
* [[Resources:Tips|Tips and tricks]]
* [[:Category:Inspiration|Inspiration]]
* [[Resources:Tools|Tools]]
* [[Resources:Links|Links]]
|HEIGHT=144px}}

|
{{RyMainPageBox|funstuff.png|[[:Category:Funstuff|Funstuff]]|
* [[Funstuff:Creating|Creating]]
|HEIGHT=144px}}

|
{{RyMainPageBox|xreal.png|[[:Category:XreaL|XreaL]]|
* [[XreaL:About|About]]
* [[XreaL:Setup|Setup]]
* [[XreaL:Games|Games]]
|HEIGHT=144px}}

|}

Radiant:Using

2011-08-21T09:31:35Z

NemNEMnem: /* How to add Weapons directly into the map */

==What is radiant?==
Radiant is a mapping tool to create .map files, which can be 'converted' into .bsp files readable by Quake 3 based games using the q3map2 compiler.

==Using radiant==

A short tutorial showing the basics of using Radiant to make maps. Tutorial - [[Radiant_Basics|Basic tutorial]]

==Getting started==

==How not to create your first room==

==How to create your first room==
A small tutorial giving a detailed tutorial on how to construct your very first room and perhaps your first map.

[[Create your first room]]

==How to create another room==

==How to create a door between 2 rooms==

==How to make a ladder==

==How to add water==

== How to make things breakable ==
Select the brushes you want to break (note that all selected brushes will break at the same time - if you want breakable windows, you will need to redo this step for every single window), open the entity menu by right clicking and then turn the selected brushes into a [[Entities:Func#func_breakable|func_breakable]].
You can edit the properties of the brush by pressing N. See [[Entities:Func#func_breakable|func_breakable reference]] for details on how to use it.

==How to make an elevator==

== How to add a model ==
Right click to open the entity menu and select [[Entities:Misc#misc_model|misc_model]]. This will open a file dialogue which allows you to choose a model.
Please note that the default filter is set to [[Models:Formats#MD3|MD3]] and you may need to change that depending on your model.
After selecting the model, you should see it in Radiant.
You can drag it around and rotate it as you like.

See the [[Entities:Misc#misc_model|misc_model reference]] for exact information.

==How to make models and prefabs using radiant==

==How to build an entire universe in a single box==

==How to add Weapons directly into the map==
There are 2 ways, one (the complicated) is this:
You create a info_spawn, press "n" and write this (for a negev) in:
classname=ut_weapon_negev -says which weapon
count=1000 -how often you can pick up the weapon and how much ammunition is in it
wait=1 -time the weapon needs for respawn
Or you download the Urban Terror Mapping Package [http://nem.cwsurf.de/?page_id=40 here] and put it into your Radiant folder.
You can select the weapons from the entity menu after restarting Radiant.

The full-list of all weapons and items which can be placed in the map you find right [http://www.custommapmakers.org/wiki/index.php/Entities:UT#ut_weapon_negev here]

[[Category:Radiant]]

Entities:UT

2011-08-21T09:26:53Z

NemNEMnem:

= ut_item =

== ut_item_extraammo ==
Give you 2 clips by running over this item.
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- NOTES --------
It looks in the Radiant and in Game like a Helmet.

== ut_item_helmet ==
The normal helmet.
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)

== ut_item_laser ==
The laser for some Weapons
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)

== ut_item_medkit ==
The medkit to heal other players.
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)

== ut_item_nvg ==
The Tacitcal Goggles.
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)

== ut_item_silencer ==
The silencer for some Weapons
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)

== ut_item_vest ==
The kevlarvest
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)

= ut_mrentry =
Spawn location for the CTF Spawn Room Sentry Cannon.
A very effective Spawnkiller-killer
-------- KEYS --------
team : Team that Mr. Sentry belongs to. Will eliminate opposing team members within range (SEE NOTES). ("red" or "blue")
angle : Inital and idle angle for the turret. Generally point this at or near the Spawn Room doors for highest effectiveness.
gametype : gametypes to have Mr. Sentry appear in, list types in this format: 01234

-------- NOTES --------
Mr. Sentry is designed to be used in conjunction with CTF Spawn Rooms (see the Notes on the func_door entity) to prevent enemy team players from surviving if they enter the opposing team's spawn room. Even though the properly set up doors will generally prevent this, Mr. Sentry also has one other function. It will kill any Flag Carrier that enters it's range no matter what team that player is on. This will prevent players from grabbing the flag and retreating the the complete safety of their Spawn Room and waiting out the rest of the map time with the flag.
For the anti-flag-camp feature to work properly, the entire spawn room must be enclosed with a 'nodrop' (a brush with the 'nodrop' texture on all sides). If this brush (or group of brushes) isn't placed, then Mr. Sentry will kill the Flag Carrier, and the flag will remain at that location, which is bad.

= ut_weapon =
== ut_weapon_ak103 ==
The AK103
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_beretta ==
The Beretta
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_bomb ==
The Bomb from bombmode - only works in Bombmode, in CTF for example you can pick it up but can't activate them.
-------- KEYS --------
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
Multiple bombs in a map would be interesting....

== ut_weapon_deagle ==
The Desert Eagle
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_g36 ==
The G36
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_grenade ==
=== ut_weapon_grenade_flash ===
Only works in 4.1 on MOD-Servers, where the flashnade is allowed, or older versions of Urban Terror.
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip

=== ut_weapon_grenade_he ===
The High-Explosion Grenade
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

=== ut_weapon_grenade_smoke ===
The Smoke-Grenade
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_hk69 ==
The HK69
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips
count of 1000 = 30 bullets 2 clips

== ut_weapon_knife ==
The Knife, you can't have more than 5 pieces
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_lr ==
The ZM LR300
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_m4 ==
The M4
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_mp5k ==
The MP5K
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_negev ==
The fullautomatic Negev
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_psg1 ==
The PSG1 Sniperrifle
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_spas ==
The Franchi Spas 12 shotgun

-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_sr8 ==
The Sr8-Sniperrifle
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

== ut_weapon_ump45 ==
The secondary-weapon UMP45
-------- KEYS --------
count: sets the amount of ammo given to the player when picked up (default 0).
gametype : Specifies gametypes for the weapon to be in in. If this key is not used, the weapon will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- Notes --------
A count has to be set in order for ammo to be in the weapon when picked up
the count system is very weird and I am unable to figure out how it works,
but here are some usefull numbers
count of 30 = 30 bullets 0 clips
count of 500 = 30 bullets 1 clip
count of 1000 = 30 bullets 2 clips

Entities:UT

2011-08-21T09:12:18Z

NemNEMnem:

Entities:UT

2011-08-21T09:04:26Z

NemNEMnem:

Entities:UT

2011-08-21T08:50:32Z

NemNEMnem:

=== ut_item ===

----

== ut_item_extraammo ==
Give you 2 clips by running over this item.
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- NOTES --------
It looks in the Radiant and in Game like a Helmet.

== ut_item_helmet ==
The normal helmet.
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)

Entities:UT

2011-08-21T07:46:57Z

NemNEMnem:

== ut_item_extraammo ==
Give you 2 clips by running over this item.
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- NOTES --------
It looks in the Radiant and in Game like a Helmet.

Entities:UT

2011-08-21T07:46:36Z

NemNEMnem: Created page with "== ut_item_extraammo Give you 2 clips by running over this item. -------- KEYS -------- gametype : Specifies gametypes for the item to be in in. If this key is not used, the item..."

== ut_item_extraammo
Give you 2 clips by running over this item.
-------- KEYS --------
gametype : Specifies gametypes for the item to be in in. If this key is not used, the item will be in all gametypes. List types in this format: 01234
wait : time in seconds before item respawns after being picked up (default 40, -1 = never respawn).
random : random time variance in seconds added or subtracted from "wait" delay
angle: direction in which model will be oriented.
target : this points to the entity to activate.
targetname : activating trigger points to this.
-------- Q3MAP2 KEYS --------
angles : Individual control of PITCH, YAW, and ROLL (default 0 0 0).
-------- SPAWNFLAGS --------
spawnflags : set to 1 to make suspended so the item will spawn where it was placed in map and won't drop to the floor. (default 0)
-------- NOTES --------
It looks in the Radiant and in Game like a Helmet.

Radiant:Using

2011-08-21T07:37:33Z

NemNEMnem: /* What is radiant? */

==What is radiant?==
Radiant is a Mapper-Tool to create a .map-file, which could be converted with a compiler, called q3map2, in a playable .bsp-file.

==Using radiant==

A short tutorial showing the basics of using Radiant to make maps. Tutorial - [[Radiant_Basics|Basic tutorial]]

==Getting started==

==How not to create your first room==

==How to create your first room==
A small tutorial giving a detailed tutorial on how to construct your very first room and perhaps your first map.

[[Create your first room]]

==How to create another room==

==How to create a door between 2 rooms==

==How to make a ladder==

==How to add water==

== How to make things breakable ==
Select the brushes you want to break (note that all selected brushes will break at the same time - if you want breakable windows, you will need to redo this step for every single window), open the entity menu by rightclicking and then turn the selected brushes into a [[Entities:Func#func_breakable|func_breakable]].
You can edit the properties of the brush by pressing N. See [[Entities:Func#func_breakable|func_breakable reference]] for details on how to use it.

==How to make an elevator==

== How to add a model ==
Rightclick to open the entity menu and select [[Entities:Misc#misc_model|misc_model]]. This will open a file dialogue which allows you to choose a model.
Please note that the default filter is set to [[Models:Formats#MD3|MD3]] and you may need to change that depending on your model.
After selecting the model, you should see it in Radiant.
You can drag it around and rotate it as you like.

See the [[Entities:Misc#misc_model|misc_model reference]] for exact information.

==How to make models and prefabs using radiant==

==How to build an entire universe in a single box==

==How to add Weapons directly into the map==
There are 2 ways, one (the complicated) is this:
You create a info_spawn, press "n" and write this (for a negev) in:
classname=ut_weapon_negev -says which weapon
count=1000 -how often you can pick up the weapon and how much ammunition is in it
wait=1 -time the weapon needs for respawn
Or you download the Urban Terror Mapping Package [http://nem.cwsurf.de/?page_id=40 here] and put it into your Radiant folder.
You can select the weapons from the entity menu after restarting Radiant.

[[Category:Radiant]]

Packaging:Levelshot

2011-08-20T20:38:51Z

NemNEMnem:

== The Template==
At first, you need the Levelshot Template, download it [http://www.urbanterror.info/downloads/static/docs/tutorials/leveldesign/levelshot.zip here].
Edit it with a Pictureditor like Gimp or Photoshop.

== The Screenshot for the Levelshot ==
Look at the best place on your map or the place you want, and make the screenshot with F11(which you add into the template), finally you find it under "q3ut4/screenshots".
It is recommended to make the screenshot with these references:

cg_draw2D 0 -This will remove the GUI
cg_drawHands 0 -This hides the gun
fov 90 -Yes 90, distortion isn't a pretty thing.
r_gamma 1 -Anything other than 1 will make your screenshot look horrible.
r_picmip 0 -Highest quality textures.
r_simpleshaders 0 -If your using the latest renderer, this enables all the new effects.
r_bloom X -Season with bloom to taste; I find r_bloom 4 a nice setting.
r_fancywater 1 -If applicable, enable fancy water.

== Saving the Screenshot ==
Save the levelshot under "q3ut4/levelshots/YOURMAPNAME.tga" and pack it with the right folderpath (levelshots should be the name of the folder) into the .pk3-file from your map.

== Notes ==
* The usual resolution is 1024x1024
[[Category:Packaging]]

Packaging:Levelshot

2011-08-20T20:36:56Z

NemNEMnem:

== The Template==
At first, you need the Levelshot Template, download it [http://www.urbanterror.info/downloads/static/docs/tutorials/leveldesign/levelshot.zip here].
Edit it with a Pictureditor like Gimp or Photoshop.

== The Screenshot for the Levelshot ==
Look at the best place on your map or the place you want, and make the screenshot with F11(which you add into the template), finally you find it under "q3ut4/screenshots".
It is recommended to make the screenshot with these references:

cg_draw2D 0 -This will remove the GUI
cg_drawHands 0 -This will stop the gun from being rendered.
fov 90 -Yes 90, distortion isn't a pretty thing.
r_gamma 1 -Anything other than 1 will make your screenshot look horrible.
r_picmip 0 -Highest quality textures.
r_simpleshaders 0 -If your using the latest renderer, this enables all the new effects.
r_bloom X -Season with bloom to taste; I find r_bloom 4 a nice setting.
r_fancywater 1 -If applicable, enable fancy water.

== Saving the Screenshot ==
Save the levelshot under "q3ut4/levelshots/YOURMAPNAME.tga" and pack it with the right folderpath (levelshots should be the name of the folder) into the .pk3-file from your map.

== Notes ==
* The usual resolution is 1024x1024
[[Category:Packaging]]

Packaging:Minimap

2011-08-20T20:09:34Z

NemNEMnem: /* Creating a Minimap with the q3map2-generator */

== Creating a Minimap with the q3map2-generator ==
You have to create a new Compiling stages, which starts with -minimap, then a -size and a -border [[File:Minimap.jpg|200px|thumb|right|Black-White Minimap]]
Here are the commands for q3map2 you can use:
* minimap ... filename.bsp: Creates a minimap of the BSP, by default writes to ../gfx/filename_mini.tga
* black: Write the minimap as a black-on-transparency RGBA32 image
* boost F: Sets the contrast boost value (higher values make a brighter image); contrast boost is somewhat similar to gamma, but continuous even at zero
* border F: Sets the amount of border pixels relative to the total image size
* gray: Write the minimap as a white-on-black GRAY8 image
* keepaspect: Ensure the aspect ratio is kept (the minimap is then letterboxed to keep aspect)
* minmax xmin ymin zmin xmax ymax zmax: Forces specific map dimensions (note: the minimap actually uses these dimensions, scaled to the target size while keeping aspect with entering, and 1/64 of border appended to all sides)
* nokeepaspect: Do not ensure the aspect ratio is kept (makes it easier to use the image in your code, but looks bad together with sharpening)
* o filename.tga: Sets the output file name
* random N: Sets the randomized supersampling count (cannot be combined with -samples)
* samples N: Sets the ordered supersampling count (cannot be combined with -random)
* sharpen F: Sets the sharpening coefficient
* size N: Sets the width and height of the output image
* white: Write the minimap as a white-on-transparency RGBA32 image

''Example for a simple Black-White Minimap:''
-minimap -size 512 -sharpen 1 -border 0

Packaging:Minimap

2011-08-20T19:55:51Z

NemNEMnem: /* Creating a Minimap with the q3map2-generator */

== Creating a Minimap with the q3map2-generator ==

This version of the map compiler can generate minimaps as used by Nexuiz.
The specs of the minimap's texture mapping are:
* Let M be the rectangle of the world's mins/maxs coordinates. [[File:Minimap.jpg|200px|thumb|right|Black-White Minimap]]
* If keepaspect is set: let S be the smallest square completely covering M whose center matches the one of M. Otherwise, let S be M.
* Let S' be S scaled by factor 1/(1-2*border) around the center of S.
* The "mins" corner of S' corresponds to the top left corner of the image.
* The "maxs" corner of S' corresponds to the bottom right corner of the image.

Packaging:Minimap

2011-08-20T19:54:43Z

NemNEMnem:

== Creating a Minimap with the q3map2-generator ==

This version of the map compiler can generate minimaps as used by Nexuiz.
The specs of the minimap's texture mapping are:
* Let M be the rectangle of the world's mins/maxs coordinates.
* If keepaspect is set: let S be the smallest square completely covering M whose center matches the one of M. Otherwise, let S be M.
* Let S' be S scaled by factor 1/(1-2*border) around the center of S.
* The "mins" corner of S' corresponds to the top left corner of the image.
* The "maxs" corner of S' corresponds to the bottom right corner of the image.

[[File:Minimap.jpg|200px|thumb|right|Black-White Minimap]]

Packaging:Minimap

2011-08-20T19:46:07Z

NemNEMnem:

== Creating a Minimap with the q3map2-generator ==

This version of the map compiler can generate minimaps as used by Nexuiz.
The specs of the minimap's texture mapping are:
* Let M be the rectangle of the world's mins/maxs coordinates.
* If keepaspect is set: let S be the smallest square completely covering M whose center matches the one of M. Otherwise, let S be M.
* Let S' be S scaled by factor 1/(1-2*border) around the center of S.
* The "mins" corner of S' corresponds to the top left corner of the image.
* The "maxs" corner of S' corresponds to the bottom right corner of the image.

Packaging:Minimap

2011-08-20T19:45:56Z

NemNEMnem: Created page with "== Creating a Minimap with the q3map2-generator == This version of the map compiler can generate minimaps as used by Nexuiz. The specs of the minimap's texture mapping are: * L..."

== Creating a Minimap with the q3map2-generator ==

This version of the map compiler can generate minimaps as used by Nexuiz.
The specs of the minimap's texture mapping are:
* Let M be the rectangle of the world's mins/maxs coordinates.
* If keepaspect is set: let S be the smallest square completely covering M whose center matches the one of M. Otherwise, let S be M.
* Let S' be S scaled by factor 1/(1-2*border) around the center of S.
* The "mins" corner of S' corresponds to the top left corner of the image.
* The "maxs" corner of S' corresponds to the bottom right corner of the image.

[URL=http://www.custommapmakers.org/wiki/images/b/b8/Minimap.jpg Extension=jpg ]

File:Minimap.jpg

2011-08-20T19:42:26Z

NemNEMnem: Black-White Minimap

Black-White Minimap

Entities:Func

2011-08-20T19:18:44Z

NemNEMnem: /* func_wall */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
''KEYS''
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value.
But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it.
Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
''KEYS''
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

''KEYS''
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

''NOTES''
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.
Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
''KEYS''
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''SPAWNFLAGS''
START_ON : timer will start on in the game and continuously fire its targets.
''NOTES''
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
''KEYS''
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
* 1. Trains always start on in the game.
* 2. Trains do not damage the played when blocked.
* 3. Trains cannot emit sound.
* 4. Trains are not triggerable or toggle-able.
* 5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

''KEYS''
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

''NOTES''
* Trains MUST HAVE AN ORIGIN BRUSH.
* The train spawns at the first target it is pointing at.
* The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
''KEYS''
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

''NOTES''
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

* Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:17:40Z

NemNEMnem: /* func_ut_train */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
''KEYS''
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value.
But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it.
Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
''KEYS''
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

''KEYS''
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

''NOTES''
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.
Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
''KEYS''
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''SPAWNFLAGS''
START_ON : timer will start on in the game and continuously fire its targets.
''NOTES''
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
''KEYS''
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
* 1. Trains always start on in the game.
* 2. Trains do not damage the played when blocked.
* 3. Trains cannot emit sound.
* 4. Trains are not triggerable or toggle-able.
* 5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

''KEYS''
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

''NOTES''
* Trains MUST HAVE AN ORIGIN BRUSH.
* The train spawns at the first target it is pointing at.
* The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:16:48Z

NemNEMnem: /* func_train */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
''KEYS''
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value.
But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it.
Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
''KEYS''
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

''KEYS''
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

''NOTES''
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.
Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
''KEYS''
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''SPAWNFLAGS''
START_ON : timer will start on in the game and continuously fire its targets.
''NOTES''
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
''KEYS''
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
* 1. Trains always start on in the game.
* 2. Trains do not damage the played when blocked.
* 3. Trains cannot emit sound.
* 4. Trains are not triggerable or toggle-able.
* 5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:15:01Z

NemNEMnem: /* func_timer */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
''KEYS''
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value.
But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it.
Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
''KEYS''
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

''KEYS''
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

''NOTES''
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.
Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
''KEYS''
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''SPAWNFLAGS''
START_ON : timer will start on in the game and continuously fire its targets.
''NOTES''
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:13:36Z

NemNEMnem: /* func_static */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
''KEYS''
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value.
But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it.
Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
''KEYS''
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

''KEYS''
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

''NOTES''
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.
Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:12:17Z

NemNEMnem: /* func_rotatingdoor */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
''KEYS''
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value.
But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it.
Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
''KEYS''
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

''KEYS''
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

''NOTES''
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:10:24Z

NemNEMnem: /* func_plat */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
''KEYS''
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value.
But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it.
Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
''KEYS''
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:09:22Z

NemNEMnem: /* func_rotating */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
''KEYS''
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value.
But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it.
Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
''KEYS''
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:08:01Z

NemNEMnem: /* func_plat */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
''KEYS''
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value.
But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it.
Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:04:32Z

NemNEMnem: /* func_pendulum */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:03:07Z

NemNEMnem: /* func_pendulum */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default.
Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:02:48Z

NemNEMnem: /* func_pendulum */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
''KEYS''
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T19:00:55Z

NemNEMnem: /* func_keyboard_interface */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

''KEYS''
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

''NOTES''
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
-------- KEYS --------
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T18:59:56Z

NemNEMnem: /* func_group */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
''OLD TERRAIN KEYS (note: obsolete with Q3Map2)''
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
''Q3MAP2 KEYS''
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''NOTES''
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

-------- KEYS --------
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

-------- NOTES --------
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
-------- KEYS --------
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T18:58:48Z

NemNEMnem: /* func_door */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

''KEYS''
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

''SPAWNFLAGS''
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

''NOTES''
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
-------- OLD TERRAIN KEYS (note: obsolete with Q3Map2) --------
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
-------- Q3MAP2 KEYS --------
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

-------- KEYS --------
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

-------- NOTES --------
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
-------- KEYS --------
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T18:57:12Z

NemNEMnem: /* func_button */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

''KEYS''
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

''NOTES''
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

-------- KEYS --------
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

-------- SPAWNFLAGS --------
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

-------- NOTES --------
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
-------- OLD TERRAIN KEYS (note: obsolete with Q3Map2) --------
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
-------- Q3MAP2 KEYS --------
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

-------- KEYS --------
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

-------- NOTES --------
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
-------- KEYS --------
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T18:55:53Z

NemNEMnem: /* func_breakable */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

-------- KEYS --------
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

-------- NOTES --------
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

-------- KEYS --------
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

-------- SPAWNFLAGS --------
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

-------- NOTES --------
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
-------- OLD TERRAIN KEYS (note: obsolete with Q3Map2) --------
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
-------- Q3MAP2 KEYS --------
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

-------- KEYS --------
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

-------- NOTES --------
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
-------- KEYS --------
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T18:54:19Z

NemNEMnem: /* func_breakable */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

''KEYS''
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

''NOTES''
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

-------- KEYS --------
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

-------- NOTES --------
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

-------- KEYS --------
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

-------- SPAWNFLAGS --------
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

-------- NOTES --------
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
-------- OLD TERRAIN KEYS (note: obsolete with Q3Map2) --------
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
-------- Q3MAP2 KEYS --------
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

-------- KEYS --------
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

-------- NOTES --------
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
-------- KEYS --------
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T18:53:40Z

NemNEMnem: /* func_bobbing */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
''KEYS''
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
''Q3MAP2 KEYS''
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
''Q3MAP2 TERRAIN KEYS''
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
''SPAWNFLAGS''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

-------- NOTES --------
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

-------- KEYS --------
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

-------- NOTES --------
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

-------- KEYS --------
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

-------- SPAWNFLAGS --------
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

-------- NOTES --------
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
-------- OLD TERRAIN KEYS (note: obsolete with Q3Map2) --------
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
-------- Q3MAP2 KEYS --------
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

-------- KEYS --------
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

-------- NOTES --------
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
-------- KEYS --------
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Func

2011-08-20T18:52:43Z

NemNEMnem: /* func_bobbing */

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
-------- KEYS --------
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
'''SPAWNFLAGS'''
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
''NOTES''
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.
Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

-------- NOTES --------
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

-------- KEYS --------
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

-------- NOTES --------
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

-------- KEYS --------
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

-------- SPAWNFLAGS --------
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

-------- NOTES --------
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
-------- OLD TERRAIN KEYS (note: obsolete with Q3Map2) --------
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
-------- Q3MAP2 KEYS --------
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

-------- KEYS --------
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

-------- NOTES --------
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
-------- KEYS --------
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]

Entities:Info

2011-08-20T18:49:05Z

NemNEMnem: /* info_null/info_notnull */

{{Stub}}
__TOC__
== info_player_deathmatch ==
Potential spawn point for a player

== info_player_start ==
Exactly the same as info_player_deathmatch.

== info_item_botroam ==
Attracts bots

== info_null/info_notnull ==
Used as a positional target for light entities to create a spotlight effect. A target_position can be used instead of this but was kept in Q3A for legacy purposes.

Keys
* targetname : must match the target key of entity that uses this for pointing.
* notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
* notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
* notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

[[Category:Entities]]

Entities:Info

2011-08-20T18:47:35Z

NemNEMnem:

{{Stub}}
__TOC__
== info_player_deathmatch ==
Potential spawn point for a player

== info_player_start ==
Exactly the same as info_player_deathmatch.

== info_item_botroam ==
Attracts bots

== info_null/info_notnull ==
Used as a positional target for light entities to create a spotlight effect. A target_position can be used instead of this but was kept in Q3A for legacy purposes.

Keys
targetname : must match the target key of entity that uses this for pointing.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

[[Category:Entities]]

Entities:Func

2011-08-20T17:13:35Z

NemNEMnem:

{{Stub}}
__TOC__
== func_bobbing ==

Solid entity that oscillates back and forth in a linear motion. By default, it will have an amount of displacement in either direction equal to the dimension of the brush in the axis in which it's bobbing. Entity bobs on the Z axis (up-down) by default. It can also emit sound if the "noise" key is set. Will crush the player when blocked.
-------- KEYS --------
speed : amount of time in seconds for one complete oscillation cycle (default 4).
height : sets the amount of travel of the oscillation movement (default 32).
phase : sets the start offset of the oscillation cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav - See Notes).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of sound and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will bob along the X axis.
Y_AXIS : entity will bob along the Y axis.
-------- NOTES --------
In order for the sound to be emitted from the entity, it is recommended to include a brush with an origin shader at its center, otherwise the sound will not follow the entity as it moves. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_breakable ==
A breakable thing just sits there, doing nothing,
but will break if damaged or collided with.

-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
color : constantLight color
light : constantLight radius
type : 0: glass 1: wood 2: ceramic 3: plastic 4: metal-normal 5: metal-explosives 6: metal-hk69 7: stone-explosives 8: stone-hk69 9: wood-explosives 10: wood-hk69(SEE NOTES)
axis : 1 - x, 2 - y, 4 - z
health : health of object
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
shards : number of shards object should shatter into (0-255)
bombable : allows the entity to be destroyed by the bomb in bomb mode. The size of blast shown when the entity breaks is determined by this value (Values : 1 none - 255 huge blast).

-------- NOTES --------
- For glass windows that break easily, set health to 1.
- Any func_breakable with a health of less than 10 will slowly weaken if a player is in contact with it. You can make a roof that collapses in after a period of time by setting the health to a value like 5. This will mean that a player standing on such a surface for around 5 seconds will fall thru. The effect is cumulative: if you stand there for 3 seconds and then come back you can only stand on it for another 2 seconds.
- The type parameter selects the shader that is used for fragments and sets the sound the object makes when it breaks.
- If the brush you are making is on an angle (for example, a skylight in a sloping roof) then you will need to set the break axis to "4" if you want it to break when people stand on it.
- You can build anything to break using the breakables. Use the model2 key to create things like breakable pots -- see Wetwired's map "ricochet" for an example.
- Set shards as high as you want (it maxes out at 32 anyway) - players can reduce the number of shards they see using cg_maxFragments
- Bombable key is to be used for things that can only be broken by the Bomb Mode bomb explosion. For example a large propane tank near a bomb target. The key's value will determine the size of the explosion graphics from this entity when broken, with a value of 1 being no explosion and a value of 255 being a large secondary blast.
- Type values info for 1,2,3,4 - The game will attenuate the damage caused by each hit to a value of 1-3. Health values above 10 will choose a random health between 6 and 10. Specifics are as follows: 0: is for glass/windows 1: is for all woods 2: is for ceramics and pottery 3: is for various plastics 4: is for metal that can be broken by normal means
- Type values info for 5,6,7,8,9,10 - The game will use the literal health value compared to the weapon damages. They should be set quite high (metals and stone at 50+). Specifics are as follows: 5: is for metal that requires explosives to break (HE grenade or hk69) 6: is for metal that requires the hk69 to break 7: is for stone that requires explosives to break (HE grenade or hk69) 8: is for stone that requires the hk69 to break 9: is for wood that requires explosives to break (HE grenade or hk69) 10: is for wood that requires the hk69 to break

== func_button ==
When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.

-------- KEYS --------
angle : determines the direction in which the button will move (up = -1, down = -2).
target : all entities with a matching targetname will be triggered.
speed : speed of button's displacement (default 40).
wait : number of seconds button stays pressed (default 1, -1 = return immediately).
lip : lip remaining at end of move (default 4 units).
health : if set to a non-zero value, the button must be damaged by "health" amount of points to operate.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
push_sound : sound that gets played when button gets pushed ("none" for nothing, defaults to a elevator Q3 sound)

-------- NOTES --------
Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_door ==
Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.

-------- KEYS --------
angle : determines the opening direction of door (up = -1, down = -2).
speed : determines how fast the door moves (default 100).
wait : number of seconds before door returns (default 2, -1 = return immediately)
lip : lip remaining at end of move (default 8)
targetname : if set, a func_button or trigger is required to activate the door.
health : if set to a non-zero value, the door must be damaged by "health" amount of points to activate (default 0).
dmg : damage to inflict on player when he blocks operation of door (default 4). Door will reverse direction when blocked unless CRUSHER spawnflag is set.
team: assign the same team name to multiple doors that should operate together (see Notes).
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone
CloseWhenIdle: when set to 1, the door will close as soon as there are no players in the triggering brush (For CTF Spawn Room doors, SEE NOTES!)
trigger_only : set to 1 if the door can only be opened by a switch or trigger (ie: prevents a player from opening it manually)
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound as door is moving
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).

-------- SPAWNFLAGS --------
START_OPEN : the door will spawn in the open state and operate in reverse.
CRUSHER : door will not reverse direction when blocked and will keep damaging player until he dies or gets out of the way.

-------- NOTES --------
- To use the CloseWhenIdle setting for CTF Spawn Room doors, you must also set trigger_only, and use a trigger_multiple to open the door. This will cause the door to remain open only as long as a player is in the triggering brush. Set the 'wait' key on the trigger_multiple to a very low value( < 1 like .25 )
- Unlike in Quake 2, doors that touch are NOT automatically teamed. If you want doors to operate together, you have to team them manually by assigning the same team name to all of them. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

== func_group ==

This is not an entity as such. It is strictly an editor utility to group world brushes and patches together for convenience (selecting, moving, copying, etc). You cannot group entities with this.
-------- OLD TERRAIN KEYS (note: obsolete with Q3Map2) --------
terrain : this is an on/off flag. When set to 1, the entity becomes a terrain entity. Note: unecessary when compiling with Q3Map2. See Q3Map2 keys.
-------- Q3MAP2 KEYS --------
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
The TAB key can be used to flip through the component pieces of a selected func_group entity, isolating individual components. To make a func_group into a terrain entity, refer to the Terrain Construction documentation.

== func_keyboard_interface ==
keyboard menu interface

-------- KEYS --------
display : if 0, menu is not dispayed, if 1, menu is displayed, default 1
id : id of the func_ut_train that this interface associates with
targetname : id for the func_ut_train key "interface" to associate it with the right func_ut_train
option1 : text message to describe the first destination
option2 : text message to describe the second destination
option3 : text message to describe the third destination
option4 : text message to describe the fourth destination
option5 : text message to describe the five destination
stop1 : targetname of first destination
stop2 : targetname of second destination
stop3 : targetname of third destination
stop4 : targetname of fourth destination
stop5 : targetname of fifth destination
stop2from1 : beginning of path from 1 to 2
stop3from1 : beginning of path from 1 to 3
stop4from1 : beginning of path from 1 to 4
stop5from1 : beginning of path from 1 to 5
stop1from2 : beginning of path from 2 to 1
stop3from2 : beginning of path from 2 to 3
stop4from2 : beginning of path from 2 to 4
stop5from2 : beginning of path from 2 to 5
stop1from3 : beginning of path from 3 to 1
stop2from3 : beginning of path from 3 to 2
stop4from3 : beginning of path from 3 to 4
stop5from3 : beginning of path from 3 to 5
stop1from4 : beginning of path from 4 to 1
stop2from4 : beginning of path from 4 to 2
stop3from4 : beginning of path from 4 to 3
stop5from4 : beginning of path from 4 to 5
stop1from5 : beginning of path from 5 to 1
stop2from5 : beginning of path from 5 to 2
stop3from5 : beginning of path from 5 to 3
stop4from5 : beginning of path from 5 to 4

-------- NOTES --------
- All the stopXfromY (where X and Y are numbers) should target a path_ut_stop
- The stopX keys (where X is a number) should target the ending path_ut_stop, i.e. the last stop at location X.
- The optionX keys (where X is a number) corresponds to the stopX keys. So if you set the name "top floor" for option1, make sure that stop1 actually is at the "top floor"

'''!!!IT IS BROKEN IN 4.x, THAT MEANS IT DOESN'T WORK!!!'''

== func_pendulum ==

Solid entity that describes a pendulum back and forth rotation movement. Rotates on the X axis by default. Pendulum frequency is a physical constant based on the length of the beam and gravity. Blocking the pendulum instantly kills a player.
-------- KEYS --------
angle : angle offset of axis of rotation from default X axis (default 0).
speed : angle of swing arc in either direction from initial position (default 30).
phase : sets the start offset of the swinging cycle. Values must be 0 < phase < 1. Any integer phase value is the same as no offset (default 0).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/jets/jets01.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. Pendulum will rotate along the X axis by default. Very crude operation: pendulum cannot rotate along Z axis, the speed of swing (frequency) is not adjustable. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_plat ==

Rising platform the player can ride to reach higher places. Plats must always be drawn in the raised position, so they will operate and be lighted correctly but they spawn in the lowered position. The plat will stay in the raised position until the player steps off. There are no proper sounds for this entity, only beep noises. It will spawn in the game and work properly but it sounds silly (see Notes).
-------- KEYS --------
speed : determines how fast the plat moves (default 150).
lip : lip remaining at end of move (default 16). Has no effect if "height" is set.
height : if set, this will determine the total amount of vertical travel of the plat.
dmg : damage to inflict on player when he blocks operation of plat (default 4). Plat will reverse direction when blocked.
targetname : if set, the trigger that points to this will raise the plat each time it fires. The plat raises and comes back down a second later if no player is on it.
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
By default, the total amount of vertical travel of a platform is implicitly determined by the overall vertical size of the brushes of which it's made minus the lip value. But if the "height" key is used, then the total amount of vertical travel of the plat will be exactly that value regardless of the shape and size of the plat and regardless of the value of the "lip" key. Using the "height" key is the best method for any kind of platforms and the only possible one for thin plats which need to travel vertical distances many times their own thickness. Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

There is a way to make plats play proper sounds. Just create a sound\movers\plats folder under baseq3 and put 2 sounds named pt1_strt.wav and pt1_end.wav in it. Those can be the renamed sounds from the Q2 plats or renamed copies of the sound\movers\doors sounds you can extract from your pak0.pk3 file or new custom sounds if you're up to it. Thanks to Fragzilla for the tip.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotating ==

Solid entity that rotates continuously. Rotates on the Z axis by default and requires an origin brush. It will always start on in the game and is not targetable.
-------- KEYS --------
speed : determines how fast entity rotates (default 100).
noise : path/name of .wav file to play. Use looping sounds only (eg. sound/world/drone6.wav).
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of entity's rotation axis and .md3 model included with entity (default "0 0 0" - See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- SPAWNFLAGS --------
X_AXIS : entity will rotate along the X axis.
Y_AXIS : entity will rotate along the Y axis.
-------- NOTES --------
You need to have an origin brush as part of this entity. The center of that brush will be the point through which the rotation axis passes. Setting the origin key is simply an alternate method to using an origin brush. It will rotate along the Z axis by default. You can check either the X_AXIS or Y_AXIS box to change that. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_rotatingdoor ==

-------- KEYS --------
pos1 : sound to play when door starts moving ("none" for nothing, defaults to a creak)
pos2 : sound to play when door stops moving ("none" for nothing, defaults to a creak)
noise : looping sound to play as door is moving (defaults to no sound)
targetname : name of a target to trigger when door opens
color : constantLight color
light : constantLight radius
direction : force door to open in a set direction: -1 is clockwise, 1 is ccw
speed : defaults to 100, speed at which door opens
wait : how long to wait until door auto-closes (default is 0, which means stay open)
trigger_only : set to 1 if the door can only be opened by a switch or trigger(ie: prevents a player from opening it manually)
axis : door rotation axis, values: 0 (for x-axis), 1(for y-axis), 2(for z-axis) (if not given, default is 2 for z-axis)
damage : damage door does to a player if they block it (leave out in most cases)
gamemode_open : gametypes to have the door locked in the open position
gamemode_shut : gametypes to have the door locked in the closed position
only : set to allow only one team to use this entity, used for CTF or other respawn type modes to create spawn rooms. Values: blue or red - Default: anyone

-------- NOTES --------
Rotating doors cannot be shot open, and will only close or open if activated
by a player. They will not automatically close after a period either. In
game modes not listed under either gamemode_open or gamemode_shut, the doors
will open and close normally.

You construct a rotating door just like a FUNC_ROTATING: it needs an origin
brush to act as the hinge.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

== func_static ==

Static non-solid bspmodel. Can be used for conditional walls and models.
-------- KEYS --------
model2 : path/name of model to include (eg: models/mapobjects/bitch/fembotbig.md3).
origin : alternate method of setting XYZ origin of .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
targetname : NOT SUPPORTED BY RENDERER - if set, a func_button or trigger can make entity disappear from the game (See Notes).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value. If a model is included with a targeted func_static, the brush(es) of the entity will be removed from the game but the .md3 model won't: it will automatically be moved to the (0 0 0) world origin so you should NOT include an .md3 model to a targeted func_static.

Because the map has only a single bot navigation file, func_static's cannot be used to make significant changes in game play flow between differing game types.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

== func_timer ==

Time delay trigger that will continuously fire its targets after a preset time delay. The time delay can also be randomized. When triggered, the timer will toggle on/off.
-------- KEYS --------
wait : delay in seconds between each triggering of its targets (default 1).
random : random time variance in seconds added or subtracted from "wait" delay (default 0 - see Notes).
target : this points to the entities to trigger.
targetname : a func_button or trigger that points to this will toggle the timer on/off when activated.
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- SPAWNFLAGS --------
START_ON : timer will start on in the game and continuously fire its targets.
-------- NOTES --------
When the random key is set, its value is used to calculate a minimum and a maximum delay. The final time delay will be a random value anywhere between the minimum and maximum values: (min delay = wait - random) (max delay = wait + random).

== func_train ==

Trains are moving solids that follow a string of path_corner entities. Trains in Q3A are very basic, they also require an origin brush (see Notes).
-------- KEYS --------
speed : speed of displacement of train (default 100 or overridden by speed value of path).
target : this points to the first path_corner of the path which is also the spawn location of the train's origin.
model2 : path/name of model to include (eg: models/mapobjects/pipe/pipe02.md3).
origin : alternate method of setting XYZ origin of the train's brush(es) and .md3 model included with entity (See Notes).
light : constantLight radius of .md3 model included with entity. Has no effect on the entity's brushes (default 0).
color : constantLight color of .md3 model included with entity. Has no effect on the entity's brushes (default 1 1 1).
notfree : when set to 1, entity will not spawn in "Free for all" and "Tournament" modes.
notteam : when set to 1, entity will not spawn in "Teamplay" and "CTF" modes.
notsingle : when set to 1, entity will not spawn in Single Player mode (bot play mode).
-------- Q3MAP2 KEYS --------
_targetname : Used to attach a misc_model entity to this entity.
_lightmapscale : Floating point value scaling the resolution of lightmaps on brushes/patches in this entity (default 1.0).
_castshadows;_cs : Allows per-entity control over shadow casting. Defaults to 0 on entities, 1 on world. 0 = no shadow casting. 1 = cast shadows on world. > 1 = cast shadows on entities with _rs (or _receiveshadows) with the corresponding value, AND world. Negative values imply same, but DO NOT cast shadows on world.
_receiveshadows;_rs : Allows per-entity control over shadow reception. Defaults to 1 on everything (world shadows). 0 = receives NO shadows. > 1 = receive shadows only from corresponding keyed entities (see above) and world. < 1 = receive shadows ONLY from corresponding keyed entities.
_celshader : Sets the cel shader used for this geometry. Note: omit the "textures/" prefix.
-------- Q3MAP2 TERRAIN KEYS --------
_indexmap;alphamap : Path/name for the art file used to guide the mapping of textures on the terrain surface.
_layers;layers : Integer value is the number unique root shaders that will be use on the terrain.
_shader;shader : Path to the metashader used to assign textures to the terrain entity. Note: Omit the "textures/" prefix.
-------- NOTES --------
1. Trains always start on in the game.
2. Trains do not damage the played when blocked.
3. Trains cannot emit sound.
4. Trains are not triggerable or toggle-able.
5. Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.

Setting the origin key is simply an alternate method to using an origin brush. When using the model2 key, the origin point of the model will correspond to the origin point defined by either the origin brush or the origin coordinate value.

Target this entity with a misc_model to have the model attached to the entity (set the model's "target" key to the same value as this entity's "targetname").

'''!!!DOESN'T WORK IN URBAN TERROR - SO IT IS USELES!!!'''

== func_ut_train ==
A train is a mover that moves between path_ut_stop target points.

-------- KEYS --------
model2 : .md3 model to also draw
name : to associate with a set of control buttons
noise : looping sound to play when the train is in motion
color : constantLight color
light : constantLight radius
speed : default 350
dmg : default 0
target : first path_ut_stop, train spawns here
interface : the targetname of the func_keyboard_interface that belongs to this train
id : to uniquely associate it with a set of control buttons
startSound : sound to play when train begins moving to a new destination
stopSound : sound to play when train arrives at a final stop
noise : constant looping sound to always be playing where the train is

-------- NOTES --------
- Trains MUST HAVE AN ORIGIN BRUSH.
- The train spawns at the first target it is pointing at.
- The train will move to any stop from any stop. See the description for the func_keyboard_interface for more info.

== func_wall ==
-------- KEYS --------
gametype : gametypes to have the wall appear in, list types in this format: 01234 (default none)

-------- NOTES --------
This entity is any brush or combination of brushes that you wish to have appear in gametypes specified.
Common uses are to cut of map sections to streamline gameplay for TS, or to expand the map for CTF or Bomb.
You cannot use a model as a func_wall.

Create your brush(es), select it (or them), then make them a func_wall and set gametype keys.

Urban Terror gametype mappings are:
Free For All 0
Single Player 1
Team Deathmatch 3
Team Survivor 4
Assasins 5
Capture And Hold 6
Capture The Flag 7
Bomb 8

[[Category:Entities]]