Mod Wiki - User contributions [en-gb]

PROCB

2007-12-12T10:40:13Z

JRAD: /* Simple Types */

=== Simple Types ===

----

'''These are all stored as little-endian'''
----

----

* bool = 1 byte
* unsigned char = 1 byte
* int = 4 bytes
* float = 4 bytes

=== Compound types ===

----

* vec3 = float x, float y, float z
* bounds = vec3 mins, vec3 maxs
* string = int length, char[ length ]

=== File Structure ===
chunk id;
chunk data;
...
chunk id;
chunk data;

=== Chunks needed for loading geometry data ===
----

==== Material Table ====
material chunk {
string id = "materials";
int numMaterials;
string array[ numMaterials ];
}

==== Model Chunk ====
model chunk {
string id = "model";
int chunkLength;
string name;

int numSurfaces;
int numAreas;
int array[ numAreas ];

for each of numSurfaces {
int materialIndex;
bool hasVertexColor;
bounds surfaceBounds;

int numVerts;
int numIndices;
int __privateCount;

for each of numVerts {
int numVertexElements; // should always be 12
float vertex[ numVertexElements ];

int numColorElements; // should always be 4
unsigned char color[ numColorElements ];
// if hasVertexColor is true, use the color read above; otherwise the color is "255 255 255 255"

// vertex[ 0 ] - x
// vertex[ 1 ] - y
// vertex[ 2 ] - z

// vertex[ 3 ] - s
// vertex[ 4 ] - t

// vertex[ 5 ] - normal x
// vertex[ 6 ] - normal y
// vertex[ 7 ] - normal z

// vertex[ 8 ] - tangent x
// vertex[ 9 ] - tangent y
// vertex[ 10 ] - tangent z
// vertex[ 11 ] - bitangent sign
}
for each of numIndices {
int index;
}

for each of __privateCount {
float __private[ 6 ];
int __private;
int __private;
int __private;
int __private;
}
}
}

all_other_chunks {
string id;
int chunkLength;
<skip ahead by chunklength to get to the next chunk>
}

PROCB

2007-12-12T10:40:01Z

JRAD: /* Simple Types */

=== Simple Types ===

'''These are all stored as little-endian'''

----

* bool = 1 byte
* unsigned char = 1 byte
* int = 4 bytes
* float = 4 bytes

=== Compound types ===

----

* vec3 = float x, float y, float z
* bounds = vec3 mins, vec3 maxs
* string = int length, char[ length ]

=== File Structure ===
chunk id;
chunk data;
...
chunk id;
chunk data;

=== Chunks needed for loading geometry data ===
----

==== Material Table ====
material chunk {
string id = "materials";
int numMaterials;
string array[ numMaterials ];
}

==== Model Chunk ====
model chunk {
string id = "model";
int chunkLength;
string name;

int numSurfaces;
int numAreas;
int array[ numAreas ];

for each of numSurfaces {
int materialIndex;
bool hasVertexColor;
bounds surfaceBounds;

int numVerts;
int numIndices;
int __privateCount;

for each of numVerts {
int numVertexElements; // should always be 12
float vertex[ numVertexElements ];

int numColorElements; // should always be 4
unsigned char color[ numColorElements ];
// if hasVertexColor is true, use the color read above; otherwise the color is "255 255 255 255"

// vertex[ 0 ] - x
// vertex[ 1 ] - y
// vertex[ 2 ] - z

// vertex[ 3 ] - s
// vertex[ 4 ] - t

// vertex[ 5 ] - normal x
// vertex[ 6 ] - normal y
// vertex[ 7 ] - normal z

// vertex[ 8 ] - tangent x
// vertex[ 9 ] - tangent y
// vertex[ 10 ] - tangent z
// vertex[ 11 ] - bitangent sign
}
for each of numIndices {
int index;
}

for each of __privateCount {
float __private[ 6 ];
int __private;
int __private;
int __private;
int __private;
}
}
}

all_other_chunks {
string id;
int chunkLength;
<skip ahead by chunklength to get to the next chunk>
}

File Formats

2007-12-11T19:11:17Z

JRAD:

PROCB

2007-12-11T19:10:48Z

JRAD:

=== Simple Types ===
These are all stored as little-endian

----

* bool = 1 byte
* unsigned char = 1 byte
* int = 4 bytes
* float = 4 bytes

=== Compound types ===

----

* vec3 = float x, float y, float z
* bounds = vec3 mins, vec3 maxs
* string = int length, char[ length ]

=== File Structure ===
chunk id;
chunk data;
...
chunk id;
chunk data;

=== Chunks needed for loading geometry data ===
----

==== Material Table ====
material chunk {
string id = "materials";
int numMaterials;
string array[ numMaterials ];
}

==== Model Chunk ====
model chunk {
string id = "model";
int chunkLength;
string name;

int numSurfaces;
int numAreas;
int array[ numAreas ];

for each of numSurfaces {
int materialIndex;
bool hasVertexColor;
bounds surfaceBounds;

int numVerts;
int numIndices;
int __privateCount;

for each of numVerts {
int numVertexElements; // should always be 12
float vertex[ numVertexElements ];

int numColorElements; // should always be 4
unsigned char color[ numColorElements ];
// if hasVertexColor is true, use the color read above; otherwise the color is "255 255 255 255"

// vertex[ 0 ] - x
// vertex[ 1 ] - y
// vertex[ 2 ] - z

// vertex[ 3 ] - s
// vertex[ 4 ] - t

// vertex[ 5 ] - normal x
// vertex[ 6 ] - normal y
// vertex[ 7 ] - normal z

// vertex[ 8 ] - tangent x
// vertex[ 9 ] - tangent y
// vertex[ 10 ] - tangent z
// vertex[ 11 ] - bitangent sign
}
for each of numIndices {
int index;
}

for each of __privateCount {
float __private[ 6 ];
int __private;
int __private;
int __private;
int __private;
}
}
}

all_other_chunks {
string id;
int chunkLength;
<skip ahead by chunklength to get to the next chunk>
}

Enemy Territory: QUAKE Wars

2007-12-11T19:09:43Z

JRAD: /* File Formats */

__NOTOC__

Welcome to the Enemy Territory: QUAKE Wars section. Here you'll find a variety of reference documentation and tutorials related to editing ETQW, along with links to the SDK. To learn more about Enemy Territory: QUAKE Wars, visit [http://www.enemyterritory.com www.enemyterritory.com].

==Software Development Kit==

The Enemy Territory: QUAKE Wars Software Development kit is currently in BETA. A list of download locations is [http://community.enemyterritory.com/index.php?q=node/210 available here].

==Tutorials==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Basics ===
|-
|
* '''[[A Simple First Map]]''' - a step-by-step guide towards making a simple map.
* '''[[A Simple Second Map]]''' - a second step-by-step guide.
* '''[[Taking A Screenshot]]''' - Settings and options for making a great screenshot!

|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Terrain ===
|-
|
* '''[[A Simple First Terrain]]''' - a step-by-step guide for terrains.
* '''[[A Simple First Megatexture]]''' - a step-by-step guide for basic Megatextures.
* '''[[Making a Terrain Model]]''' - more detailed guide for terrain meshes.
* '''[[An Advanced Terrain and Megatexture]]''' - a comprehensive guide for making detailed terrain models with Megatextures.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |

=== Vehicles ===
|-
|
* '''[[Vehicle Tutorial]]''' - The whole thing! Click below for smaller segments.
** '''[[Vehicle Tutorial Part 1|Step 1]]''' - Design considerations, before you do anything else!
** '''[[Vehicle Tutorial Part 2|Step 2]]''' - Initial rough model, rig and basic script.
** '''[[Vehicle Tutorial Part 3|Step 3]]''' - More advanced rig and scripting.
** '''[[Vehicle Tutorial Part 4|Step 4]]''' - Further technical setup ideas.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models & Textures ===
|-
|
* '''[[Adding Custom Textures]]''' - Create materials to add your own custom textures to the game.
* '''[[Making A Normal Map]]''' - Using Renderbump to generate a bump-map from a high-poly model.
|-
|}
|}

==Script & Code==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Coding ===
|-
|
* '''[[Windows Code Notes]]''' - General information about compiling on Windows.
* '''[[Linux Code Notes]]''' - General information about compiling on Linux systems.
* '''[[Generating Compiled Scripts]]''' - Information on building a compiledscript DLL.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Declarations ===
|-
|
* '''[[Materials]]''' - All you need to know about material declarations.
* '''[[Templates]]''' - Setting up templates to save time and effort.
* '''[[Surface Types]]''' - Available surface types for particle & sound effects.
* '''[[Skins]]''' - Easily switch textures on surfaces.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Vehicle Scripting ===
|-
|
* '''[[Vehicle Scripting: Basic_Overview|Basic Overview]]''' - Introduction to vehicle setup.
* '''[[Vehicle Scripting: Entity_Definition|Entity Definition]]''' - One definition to rule them all!
* '''[[Vehicle Scripting: Vehicle_Definition|Vehicle Definition]]''' - Introduction to the ''.vscript'' file.
* '''[[Vehicle Scripting: Positions_&_Views|Positions & Views]]''' - Configuring player positions & camera views.
* '''[[Vehicle Scripting: Components|Components]]''' - Details of various vehicle components.
* '''[[Vehicle Scripting: Weapons|Weapons]]''' - Things that go boom!
* '''[[Vehicle Scripting: IK|IK]]''' - Inverse Kinematics & you...
* '''[[Vehicle Scripting: Cockpits|Cockpits]]''' - Cockpit setup.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Entity Scripting ===
|-
|
* '''[[EntityClass:Overview|Classes]]''' - Tree of entity types.
* '''[[ScriptEvent:List|Events]]''' - List of all script events.
* '''[[Scripting:Examples|Examples]]''' - Some example walkthoughs of building up a scripted entity.
* '''[[Script:Files|Script Files]]''' - List of the script files used by the game.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== GUIs ===
|-
|
* '''[[GUIs|GUI Overview]]''' - Overview of the GUI system.
* '''[[GUIs: Event Based Scripting|Event Based Scripting]]''' - GUIs are event-based.
* '''[[GUIs: Materials|Materials]]''' - Using materials in GUIs.
* '''[[GUIs: Transitions|Transitions]]''' - Transitions.
* '''[[GUIs: Templates|Templates]]''' - Using templates in GUIs.
* '''[[GUIs: List Enumeration|List Enumeration]]''' - List enumerations.
* '''[[GUIs: Properties|Properties]]''' - Player/Global properties and more.
* '''[[GUIs: Timelines|Timelines]]''' - GUI timelines.
* '''[[GUIs: Layouts|Layouts]]''' - Window layouts.
* '''[[Reference (GUIs)|Reference]]''' - GUI reference.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== File Formats ===
|-
|
* '''[[PROCB|PROCB Mesh Data]]''' - Loading mesh data from a procb file.
|-
|}
|}

==Design==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== The Basics ===
|-
|
* '''[[A Simple First Map]]''' - step-by-step guide towards making a simple map
* '''[[A Simple Second Map]]''' - step-by-step guide towards making a simple map
* '''[[A Simple First Terrain]]''' - step-by-step guide creating a simple terrain
* '''[[An Advanced Map]]''' - includes terrain
* '''[[Design: How do I|How do I ...?]]''' - Common and useful tasks
* '''[[Map Troubleshooting]]''' - Common problems and fixes
----
* '''[[Brush Basics]]'''
* '''[[Entity Basics]]'''
* '''[[Lighting Basics]]'''
* '''[[Portal Basics]]'''
----
* '''[[Common Textures]]'''
* '''[[Decals]]'''
* '''[[Editor Groups]]'''
* '''[[Map Objects]]'''
* '''[[References]]'''
* '''[[Sound]]'''
* '''[[Texturesheets]]'''
* '''[[Water]]'''
----
* '''[[Ambient Light Editor]]'''
* '''[[Atmosphere Editor]]'''
* '''[[Texture Editor]]'''
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |

=== Advanced Stuff ===
|-
|
* '''[[Batches]]'''
* '''[[Deployables]]'''
* '''[[Detail Groups]]'''
* '''[[Developer cheats]]'''
* '''[[List of Entities]]''' - Descriptions for all entities
* '''[[LOD Groups]]'''
* '''[[Locations]]'''
* '''[[Model Instancing]]'''
* '''[[Occlusion Tests]]'''
* '''[[Performance Optimizations]]'''
* '''[[Surface Tree]]'''
* '''[[Surface Types]]'''
* '''[[Terrain Editing]]'''
* '''[[Terrain Editor]]'''
* '''[[Vehicle Route Constraint System]]'''
|-
|}
|}

==Art==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models ===
|-
|
* '''[[In-Game Models]]''' - Making models for use in the engine.
* '''[[Collision Meshes]]''' - Optimized models for in-game physics collision.
* '''[[High-Poly Models]]''' - Making source models for baking normal maps.
* '''[[Renderbump]]''' - Create normal maps from high-poly geometry.
* '''[[Imposters]]''' - Sprites used for rendering complex models cheaply at a distance.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Animation ===
|-
|
* '''[[MD5 Export Process]]''' - How to export an animated MD5.
* '''[[Vehicle Setup]]''' - How to set up a vehicle.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Textures ===
|-
|
* '''[[Basic Texture Overview]]''' - Supported texture types and implementations.
* '''[[Texturesheets]]''' - Overview of what texturesheets are, and when to use them.
* '''[[The Atlas Editor]]''' - Create environment texture sheets to improve performance.
* '''[[RenderBumpFlat]]''' - Create normal-maps from high-poly geometry.
* '''[[Detail Textures]]''' - Add high-frequency detail to your textures.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Terrain Editing ===
|-
|
* '''[[A Simple First Terrain]]''' - Simple steps to creating a terrain-based map.
* '''[[A Simple First Megatexture]]''' - Following on from the Simple First Terrain tutorial.
* '''[[Generate a MegaTexture]]''' - Render and compile your Megatexture.
* '''[[An Advanced Terrain and Megatexture]]''' - A detailed guide to making a realistic, natural terrain and Megatexture.
* '''[[Terrain Editor|EditWorld's Terrain Editor]]''' - Set up a Surface Tree for your Megatexture.
* '''[[Making a Terrain Model]]''' - All aspects of terrain mesh creation including Out-of-Bounds geometry.
* '''[[Water Surfaces#Water Models|Water Surfaces]]''' - Create water to go with your landscape.
* '''[[STUFF System]]''' - Procedurally distribute models over your terrain mesh.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Atmospheres and Effects ===
|-
|
* '''[[Atmosphere Editor|The Atmosphere Editor]]''' - Create and edit atmospheres for your map.
* '''[[Ambient Light Editor|The Ambient Light Editor]]''' - Create and edit ambient light setups.
* '''[[Environment Maps]]''' - Used for reflection effects.
* '''[[Water Surfaces]]''' - Creating water effects.
* '''[[Effects Editor|The Effects Editor]]''' - Create and edit particle effects.
* '''[[Cheap Decals]]''' - Bulletholes and other collision decals.
|-
|}
|}

File Formats

2007-12-11T18:26:30Z

JRAD:

Enemy Territory: QUAKE Wars

2007-12-11T18:11:31Z

JRAD: /* Script & Code */

__NOTOC__

Welcome to the Enemy Territory: QUAKE Wars section. Here you'll find a variety of reference documentation and tutorials related to editing ETQW, along with links to the SDK. To learn more about Enemy Territory: QUAKE Wars, visit [http://www.enemyterritory.com www.enemyterritory.com].

==Software Development Kit==

The Enemy Territory: QUAKE Wars Software Development kit is currently in BETA. A list of download locations is [http://community.enemyterritory.com/index.php?q=node/210 available here].

==Tutorials==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Basics ===
|-
|
* '''[[A Simple First Map]]''' - a step-by-step guide towards making a simple map.
* '''[[A Simple Second Map]]''' - a second step-by-step guide.
* '''[[Taking A Screenshot]]''' - Settings and options for making a great screenshot!

|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Terrain ===
|-
|
* '''[[A Simple First Terrain]]''' - a step-by-step guide for terrains.
* '''[[A Simple First Megatexture]]''' - a step-by-step guide for basic Megatextures.
* '''[[Making a Terrain Model]]''' - more detailed guide for terrain meshes.
* '''[[An Advanced Terrain and Megatexture]]''' - a comprehensive guide for making detailed terrain models with Megatextures.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |

=== Vehicles ===
|-
|
* '''[[Vehicle Tutorial]]''' - The whole thing! Click below for smaller segments.
** '''[[Vehicle Tutorial Part 1|Step 1]]''' - Design considerations, before you do anything else!
** '''[[Vehicle Tutorial Part 2|Step 2]]''' - Initial rough model, rig and basic script.
** '''[[Vehicle Tutorial Part 3|Step 3]]''' - More advanced rig and scripting.
** '''[[Vehicle Tutorial Part 4|Step 4]]''' - Further technical setup ideas.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models & Textures ===
|-
|
* '''[[Adding Custom Textures]]''' - Create materials to add your own custom textures to the game.
* '''[[Making A Normal Map]]''' - Using Renderbump to generate a bump-map from a high-poly model.
|-
|}
|}

==Script & Code==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Coding ===
|-
|
* '''[[Windows Code Notes]]''' - General information about compiling on Windows.
* '''[[Linux Code Notes]]''' - General information about compiling on Linux systems.
* '''[[Generating Compiled Scripts]]''' - Information on building a compiledscript DLL.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Declarations ===
|-
|
* '''[[Materials]]''' - All you need to know about material declarations.
* '''[[Templates]]''' - Setting up templates to save time and effort.
* '''[[Surface Types]]''' - Available surface types for particle & sound effects.
* '''[[Skins]]''' - Easily switch textures on surfaces.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Vehicle Scripting ===
|-
|
* '''[[Vehicle Scripting: Basic_Overview|Basic Overview]]''' - Introduction to vehicle setup.
* '''[[Vehicle Scripting: Entity_Definition|Entity Definition]]''' - One definition to rule them all!
* '''[[Vehicle Scripting: Vehicle_Definition|Vehicle Definition]]''' - Introduction to the ''.vscript'' file.
* '''[[Vehicle Scripting: Positions_&_Views|Positions & Views]]''' - Configuring player positions & camera views.
* '''[[Vehicle Scripting: Components|Components]]''' - Details of various vehicle components.
* '''[[Vehicle Scripting: Weapons|Weapons]]''' - Things that go boom!
* '''[[Vehicle Scripting: IK|IK]]''' - Inverse Kinematics & you...
* '''[[Vehicle Scripting: Cockpits|Cockpits]]''' - Cockpit setup.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Entity Scripting ===
|-
|
* '''[[EntityClass:Overview|Classes]]''' - Tree of entity types.
* '''[[ScriptEvent:List|Events]]''' - List of all script events.
* '''[[Scripting:Examples|Examples]]''' - Some example walkthoughs of building up a scripted entity.
* '''[[Script:Files|Script Files]]''' - List of the script files used by the game.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== GUIs ===
|-
|
* '''[[GUIs|GUI Overview]]''' - Overview of the GUI system.
* '''[[GUIs: Event Based Scripting|Event Based Scripting]]''' - GUIs are event-based.
* '''[[GUIs: Materials|Materials]]''' - Using materials in GUIs.
* '''[[GUIs: Transitions|Transitions]]''' - Transitions.
* '''[[GUIs: Templates|Templates]]''' - Using templates in GUIs.
* '''[[GUIs: List Enumeration|List Enumeration]]''' - List enumerations.
* '''[[GUIs: Properties|Properties]]''' - Player/Global properties and more.
* '''[[GUIs: Timelines|Timelines]]''' - GUI timelines.
* '''[[GUIs: Layouts|Layouts]]''' - Window layouts.
* '''[[Reference (GUIs)|Reference]]''' - GUI reference.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== File Formats ===
|-
|
* '''[[File Formats|PROCB Mesh Data]]''' - Loading mesh data from a procb file.
|-
|}
|}

==Design==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== The Basics ===
|-
|
* '''[[A Simple First Map]]''' - step-by-step guide towards making a simple map
* '''[[A Simple Second Map]]''' - step-by-step guide towards making a simple map
* '''[[A Simple First Terrain]]''' - step-by-step guide creating a simple terrain
* '''[[An Advanced Map]]''' - includes terrain
* '''[[Design: How do I|How do I ...?]]''' - Common and useful tasks
* '''[[Map Troubleshooting]]''' - Common problems and fixes
----
* '''[[Brush Basics]]'''
* '''[[Entity Basics]]'''
* '''[[Lighting Basics]]'''
* '''[[Portal Basics]]'''
----
* '''[[Common Textures]]'''
* '''[[Decals]]'''
* '''[[Editor Groups]]'''
* '''[[Map Objects]]'''
* '''[[References]]'''
* '''[[Sound]]'''
* '''[[Texturesheets]]'''
* '''[[Water]]'''
----
* '''[[Ambient Light Editor]]'''
* '''[[Atmosphere Editor]]'''
* '''[[Texture Editor]]'''
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |

=== Advanced Stuff ===
|-
|
* '''[[Batches]]'''
* '''[[Deployables]]'''
* '''[[Detail Groups]]'''
* '''[[Developer cheats]]'''
* '''[[List of Entities]]''' - Descriptions for all entities
* '''[[LOD Groups]]'''
* '''[[Locations]]'''
* '''[[Model Instancing]]'''
* '''[[Occlusion Tests]]'''
* '''[[Performance Optimizations]]'''
* '''[[Surface Tree]]'''
* '''[[Surface Types]]'''
* '''[[Terrain Editing]]'''
* '''[[Terrain Editor]]'''
* '''[[Vehicle Route Constraint System]]'''
|-
|}
|}

==Art==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models ===
|-
|
* '''[[In-Game Models]]''' - Making models for use in the engine.
* '''[[Collision Meshes]]''' - Optimized models for in-game physics collision.
* '''[[High-Poly Models]]''' - Making source models for baking normal maps.
* '''[[Renderbump]]''' - Create normal maps from high-poly geometry.
* '''[[Imposters]]''' - Sprites used for rendering complex models cheaply at a distance.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Animation ===
|-
|
* '''[[MD5 Export Process]]''' - How to export an animated MD5.
* '''[[Vehicle Setup]]''' - How to set up a vehicle.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Textures ===
|-
|
* '''[[Basic Texture Overview]]''' - Supported texture types and implementations.
* '''[[Texturesheets]]''' - Overview of what texturesheets are, and when to use them.
* '''[[The Atlas Editor]]''' - Create environment texture sheets to improve performance.
* '''[[RenderBumpFlat]]''' - Create normal-maps from high-poly geometry.
* '''[[Detail Textures]]''' - Add high-frequency detail to your textures.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Terrain Editing ===
|-
|
* '''[[A Simple First Terrain]]''' - Simple steps to creating a terrain-based map.
* '''[[A Simple First Megatexture]]''' - Following on from the Simple First Terrain tutorial.
* '''[[Generate a MegaTexture]]''' - Render and compile your Megatexture.
* '''[[An Advanced Terrain and Megatexture]]''' - A detailed guide to making a realistic, natural terrain and Megatexture.
* '''[[Terrain Editor|EditWorld's Terrain Editor]]''' - Set up a Surface Tree for your Megatexture.
* '''[[Making a Terrain Model]]''' - All aspects of terrain mesh creation including Out-of-Bounds geometry.
* '''[[Water Surfaces#Water Models|Water Surfaces]]''' - Create water to go with your landscape.
* '''[[STUFF System]]''' - Procedurally distribute models over your terrain mesh.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Atmospheres and Effects ===
|-
|
* '''[[Atmosphere Editor|The Atmosphere Editor]]''' - Create and edit atmospheres for your map.
* '''[[Ambient Light Editor|The Ambient Light Editor]]''' - Create and edit ambient light setups.
* '''[[Environment Maps]]''' - Used for reflection effects.
* '''[[Water Surfaces]]''' - Creating water effects.
* '''[[Effects Editor|The Effects Editor]]''' - Create and edit particle effects.
* '''[[Cheap Decals]]''' - Bulletholes and other collision decals.
|-
|}
|}

A Simple First Terrain

2007-12-05T10:33:51Z

JRAD: /* Assigning a Material */

This is the barebones guide towards creating your first simple terrain and adding it to a map. This terrain won't be as detailed or as attractive as a full terrain, but will demonstrate the basics of creating a terrain mesh, assigning a texture, and adding it in-game.

== Introduction ==
'''For this tutorial you must:'''
* Have a modelling package that can export as OBJ
* Have basic modelling skills
* Have basic mapping skills

If you can't do any of the above things, this tutorial is not for you!

'''This tutorial covers:'''
* How to create a terrain mesh and caulk hull
* How to add a terrain mesh to a map
* How to assign a texture
* How to work with terrain meshes and map geometry

'''This tutorial does not cover:'''
* How to use Blender/Maya/Lightwave/ZBrush/Mudbox/3DSMax
* How to create a megatexture
* How to create displacement maps
* Anything complicated

== Building the Terrain Mesh ==
[[Image:simpleterrain_mesh.png|thumb|400px|A simple terrain mesh created in Blender]]
Use your preferred modelling package to create a basic terrain mesh that is exactly 32,768 units long and wide.

It is preferable to keep the terrain as basic as possible, so it can be refined later on during the mapping process. For this reason, the terrain mesh here only contains a very very rough formation of bumps (or 'mountains' as they might be known)

''While you can use any dimensions for your terrain mesh - it is strongly advised to stick to 8k*8k, 16*16k or 32k*32k''
{{clear}}

== Creating a Caulk Hull ==
[[Image:simpleterrain_caulkhull.png|thumb|400px|The caulk hull]]
Since maps must be leak-free/sealed, maps with terrain must have a caulk hull to ensure this is the case.

In this case, since the terrain is 32768 units long and wide, the caulk hull should also be the same dimensions. The caulk hull is quickly created from a brush 32768 units long, 32768 wide and 16384 units tall, which is then hollowed. The brushes are also assigned the 'editor/noimpactcaulk' texture, which prevents gunshots and projectiles from hitting the surfaces of the hull (they simply disappear instead.)

{{clear}}

== Setting The Terrain ==
[[Image:simpleterrain_terraineditor.png|thumb|200px|The Terrain Editor]]
The mesh must be triangulated before it is exported as an .OBJ, and saved as {{filename|models/terrain/simpleterrain.obj}}. At this stage, a texture is not necessary, and can be set later.

Terrains are set up in the Terrain Editor, accessible via {{accelkey|shift}}{{accelkey|N}}. This tool creates a Surface Tree file ({{filename|.sft}}) that contains all the information about the terrain, including roads, stamps, and detail texture information that MegaBuild needs to generate a Megatexture.
{{clear}}

[[Image:simpleterrain_terraineditor2.png|thumb|200px|Root node set up to use the correct terrain mesh]]
To set the mesh to the map, first press 'Begin Editing' at the bottom of the Terrain Editor window. Then {{accelbtn|RMB}} on the left-hand pane and create a new Tree via the menu. This creates a Root node on which all the terrain information resides. Clicking on the Root node allows a model to be specified - set {{keyname|Model}} to the name of the terrain mesh, in this case {{keyvalue|models/terrain/simpleterrain.obj}}. Press {{accelkey|enter}} to confirm and the terrain should appear in the 3D view, with the red placeholder material.

At this point you may add a player spawn, an atmosphere, and compile the level to check the terrain. However, since there is no material set, there will be rendering issues.

''You may find the 3D terrain is partly covered or obscured by the base of caulk hull. This can be fixed by moving or resizing the caulk hull so it contains the terrain properly.''
{{clear}}

== Assigning a Material ==
[[Image:simpleterrain_textured.png|thumb|200px|Textured terrain mesh]]
It is not possible to assign materials to terrain meshes in EditWorld, you must do this process in your modelling application.

For testing purposes, terrain meshes are often assigned a temporary material until they are in a state that they can be textured properly. Traditionally, this has been one of the existing materials in the game, such as concrete - {{filename|textures/concrete/concrete10}} (although any valid material will work.)

Due to an oddity with the OBJ format, the material name {{filename|textures/concrete/concrete10}} is not valid inside an OBJ file. Instead, the material should be named {{filename|textures__concrete__concrete10}}, where the slashes are replaced by double underscores (single underscores will not work!).

Setting the mesh material differs between modelling packages. However, since OBJ files are text, they can be manually edited with a text editor instead of using the modelling application. The OBJ will contain a line (often about halfway through) starting with <tt>usemtl</tt> followed by an arbitrary texture name. This line should be replaced with <tt>usemtl textures__concrete__concrete10</tt> and the file saved.

If you are using Lightwave, 3ds Max, or Maya, you should not have to text-edit any files, just set the material name in the relevant section of the material editor.

editWorld can then be told to reload the OBJ (now with a proper material declaration) via ''Misc -> Reload -> Models'' or clicking the "Reload Models" button.

''Instead of using the concrete texture, you can use one of the existing Megatextures. For example, to use Area22's megatexture, simply set the mesh's material name to {{filename|megatextures__area22}}.''
{{clear}}

== Map Geometry ==
[[Image:simpleterrain_building.png|thumb|200px|Exported geometry used to help edit the terrain]]
The map and terrain are now in a state that they can be used for level design, however difficulty can arise ensuring the structures in the level fit to the terrain.

This can be countered using editWorld's export tool, which exports map geometry for importing into the modelling package alongside the terrain. This can be done by selecting the geometry to export (such as a building or a reference, located anywhere in the map), and pressing {{accelkey|ctrl}}{{accelkey|e}}. This writes the geometry to {{filename|models/export.obj}}.
{{clear}}

[[Image:simpleterrain_refinedmesh.png|thumb|200px|Exported geometry used to help edit the terrain]]
The exported geometry can then be used as a template to modify the terrain accordingly - such as flattening areas of land to fit buildings, cutting holes for entrances of simply adding more detail. The modified terrain mesh is then saved for further work in editWorld.

Most often, terrain vertices are snapped to the corners of buildings and structures, such that the terrain faces now covered by the building can be deleted. This allows for buildings to sink into the terrain, and lead into underground areas of the map.
{{clear}}

[[Image:simpleterrain_fixedterrain.png|thumb|200px|Terrain after being edited to fit the geometry.]]
This process of refinement is repeated many times throughout the life of the map, ensuring the terrain precisely fits the map geometry.

''When working with terrained maps, most level geometry is stored in separate [[References]] to allow for easy editing.''
{{clear}}

== That's it! ==
[[Image:simpleterrain_ingame.png|thumb|400px|Terrain in-game]]
You've now created a map with your very own terrain!

'''Things to try:'''
* Assign a different texture to the terrain mesh
* Make the terrain an island with [[Water Surfaces]]
* Cut a hole in the terrain to create an underground area

{{clear}}

== Advanced Bits and Pieces ==

=== Atmosphere ===
You may find your atmosphere doesn't project sunlight and shadow correctly. This is because the engine needs to know the area you have created is outside. The simplest way to do this is to create a brush in the corner of the caulk hull, textured with 'editor/outsideportal'.

=== Terrain Mesh UVs ===
If you find your terrain is a constant grey, rather than showing a texture (as in the screenshots) it may mean your mesh UVs are incorrect. Consult your modelling package to find out how to reset or unwrap the UVs on the terrain mesh.

== See Also ==
* [[Making a Terrain Model]] - an advanced guide for complete terrain creation
* [[Design: How do I|How do I...?]] - how to do common tasks
* [[A Simple First Map]] - the first mapping tutorial
* [[A Simple Second Map]] - the second mapping tutorial
* [[An Advanced Map]] - a more complex guide to creating a map, including terrain
* [[Design: Troubleshooting]] - troubleshooting guide

[[Category:Basic Level Design]]
[[Category:Tutorials]]

Vehicle Scripting: IK

2007-12-04T17:48:33Z

JRAD: /* Introduction */

Describes IK used for vehicle positions and suspension.<includeonly>

{{main|Vehicle Scripting: IK}}</includeonly><noinclude>

= Vehicle Position IK =

== Introduction ==

Inverse kinematic (IK) systems can be added to vehicles, allowing joints to be manipulated based on the player's view direction, amongst other things. For example aiming a weapon by rotating a turret and elevating a barrel, or keeping the player's hands on the steering wheel.

IK systems are added within positionDef blocks in the vehicleDef.

Properties:
* <tt>name</tt> - the name of the IK system, to identify it in the code.
* <tt>type</tt> - the code class to use, defines the behaviour of the IK system. Types detailed below.
* <tt>parms</tt> - a block of key/value pairs, providing the parameters to the code class.

The IK systems can also have pitch & yaw clamps.

== Types ==

=== Common ===

One key is common to all the IK types:
* <tt>"weapon"</tt> - The name of the weapon associated with this IK. The player using this weapon is the player that will govern the IK. If not specified then the player in the position is the one that governs the IK. The name used here should be the value of the <tt>"weapon_name"</tt> key in the stringMap of the desired weapon.

=== sdVehicleIKArms ===

This is used for weapons that are in an arm-like configuration - for example a gun on a tripod.

'''Keys:'''
* <tt>"jointElbow"</tt> - Joint that is yawed to aim
* <tt>"jointWrist"</tt> - Joint that is pitched to aim - this should be down the hierarchy from <tt>"jointElbow"</tt>
* <tt>"jointMuzzle"</tt> - Joint that needs to be pointed at the target - eg the muzzle of the weapon. This should be down the hierarchy from jointMuzzle.
* <tt>"pitchAxis"</tt> - Selects which axis of the wrist joint is rotated to pitch towards the target.
*: 1 = x-axis, 2 = y-axis, 3 = z-axis. Making this value negative reverses the direction of the pitch.
*: Defaults to 2.

=== sdVehicleSwivel===

This IK type simply rotates the joint with the aim of the player associated.

'''Keys'''
* <tt>"joint"</tt> - The joint to be rotated.

=== sdVehicleWeaponAimer ===

This IK attempts to aim the muzzle joint at the player's target. This is the form of IK integrated into the <tt>sdVehicleWeaponFixedMinigun</tt> weapon type, with differing key names.

'''Keys:'''
* <tt>"jointShoulder"</tt> - Base joint for the aiming. If not specified, the parent joint of the elbow is used.
* <tt>"jointElbow"</tt> - Joint that is yawed to aim
* <tt>"jointWrist"</tt> - Joint that is pitched to aim - this should be down the hierarchy from <tt>"jointElbow"</tt>
* <tt>"jointMuzzle"</tt> - Joint that needs to be pointed at the target - eg the muzzle of the weapon. This should be down the hierarchy from jointMuzzle.
* <tt>"deployed_anim"</tt> - Animation that is used to gather initial calibration parameters (for models that have a differing animation at spawn)
* <tt>"fix_barrel"</tt> - Re-orient a wayward muzzle joint
* <tt>"invert_pitch"</tt> - Flips the pitching behaviour of the IK

=== sdVehicleJointAimer ===

This aims a single joint at the player's target.

'''Keys:'''
* <tt>"joint"</tt> - Joint to be aimed
* <tt>"weapon2"</tt> - Allows a second weapon to be associated with the IK, so that it also aims the joint when that weapon is in use.

=== sdVehicleIK_Steering ===

This IK is used to keep the player's hand joints attached to two joints on the vehicle - for example a steering wheel, or the handlebars of the Husky.

'''Keys:'''
* <tt>"joint_left"</tt> - The joint the left hand should be attached to
* <tt>"joint_right"</tt> - The joint the right hand should be attached to

= Suspension IK =

== Introduction ==

Vehicle <tt>wheel</tt> & <tt>suspension</tt> parts can have a string map associated with them to give them IK. This allows joints to be specially animated, for example wishbone suspension or landing legs. They are provided with information from the vehicle part about the length of the suspension, and the suspension IK manipulate joints to make it look like the vehicle is reacting to the changing length.

== Types ==

There are a number of different IK types that can be used, each providing a different appearance. The type is selected with the <tt>"type"</tt> key of the string map. The types of IK are listed below.

=== <tt>"pivot"</tt> ===

In this system the suspension offset is achieved by rotating a single joint.

'''Keys:'''
* <tt>"joint"</tt> - The joint that is rotated
* <tt>"reverse"</tt> - Reverses the response to the changing length

=== <tt>"double_wishbone"</tt> ===

This system rotates two joints, an upper joint and a lower joint.

'''Keys:'''
* <tt>"joint_upper"</tt> - The upper joint to be rotated
* <tt>"joint_lower"</tt> - The lower joint to be rotated
* <tt>"lerp_scale"</tt> - How quickly the system responds to changes in suspension length. <tt>1</tt> means it will instantly reach the new position, <tt>0</tt> means it will never respond. Defaults to <tt>0.5</tt>.

=== <tt>"vertical"</tt> ===

This type simply moves a single joint up and down as the suspension length changes.

'''Keys:'''
* <tt>"joint"</tt> - The joint to be moved up and down.

=== <tt>"2jointleg"</tt> ===

This type rotates two joints - a "hip" joint and a "knee" joint.

'''Keys:'''
* <tt>"joint_hip"</tt> - The hip joint.
* <tt>"joint_knee"</tt> - The knee joint.
* <tt>"dir_hip"</tt> - The direction (in the local space of the vehicle) the hip should rotate in. Defaults to <tt>"0 0 1"</tt>
* <tt>"lerp_scale"</tt> - How quickly the system responds to changes in suspension length. <tt>1</tt> means it will instantly reach the new position, <tt>0</tt> means it will never respond. Defaults to <tt>0.5</tt>.
* <tt>"reverse"</tt> - Reverses the response to the changing length

[[Category:Vehicles]]

</noinclude>

Vehicle Scripting: IK

2007-12-04T17:48:24Z

JRAD: /* sdVehicleWeaponAimer */

Describes IK used for vehicle positions and suspension.<includeonly>

{{main|Vehicle Scripting: IK}}</includeonly><noinclude>

= Vehicle Position IK =

== Introduction ==

Inverse kinematic (IK) systems can be added to vehicles, allowing joints to be manipulated based on the player's view direction, amongst other things. For example aiming a weapon by rotating a turret and elevating a barrel, or keeping the player's hands on the steering wheel.

IK systems are added within positionDef blocks in the vehicleDef.

Properties:
* <tt>name</tt> - the name of the IK system, to identify it in the code.
* <tt>type</tt> - the code class to use, defines the behaviour of the IK system. Types detailed below.
* <tt>parms</tt> - a block of key/value pairs, providing the parameters to the code class.

The IK systems can also have pitch & yaw clamps. '''TODO: FLESH THIS OUT'''

== Types ==

=== Common ===

One key is common to all the IK types:
* <tt>"weapon"</tt> - The name of the weapon associated with this IK. The player using this weapon is the player that will govern the IK. If not specified then the player in the position is the one that governs the IK. The name used here should be the value of the <tt>"weapon_name"</tt> key in the stringMap of the desired weapon.

=== sdVehicleIKArms ===

This is used for weapons that are in an arm-like configuration - for example a gun on a tripod.

'''Keys:'''
* <tt>"jointElbow"</tt> - Joint that is yawed to aim
* <tt>"jointWrist"</tt> - Joint that is pitched to aim - this should be down the hierarchy from <tt>"jointElbow"</tt>
* <tt>"jointMuzzle"</tt> - Joint that needs to be pointed at the target - eg the muzzle of the weapon. This should be down the hierarchy from jointMuzzle.
* <tt>"pitchAxis"</tt> - Selects which axis of the wrist joint is rotated to pitch towards the target.
*: 1 = x-axis, 2 = y-axis, 3 = z-axis. Making this value negative reverses the direction of the pitch.
*: Defaults to 2.

=== sdVehicleSwivel===

This IK type simply rotates the joint with the aim of the player associated.

'''Keys'''
* <tt>"joint"</tt> - The joint to be rotated.

=== sdVehicleWeaponAimer ===

This IK attempts to aim the muzzle joint at the player's target. This is the form of IK integrated into the <tt>sdVehicleWeaponFixedMinigun</tt> weapon type, with differing key names.

'''Keys:'''
* <tt>"jointShoulder"</tt> - Base joint for the aiming. If not specified, the parent joint of the elbow is used.
* <tt>"jointElbow"</tt> - Joint that is yawed to aim
* <tt>"jointWrist"</tt> - Joint that is pitched to aim - this should be down the hierarchy from <tt>"jointElbow"</tt>
* <tt>"jointMuzzle"</tt> - Joint that needs to be pointed at the target - eg the muzzle of the weapon. This should be down the hierarchy from jointMuzzle.
* <tt>"deployed_anim"</tt> - Animation that is used to gather initial calibration parameters (for models that have a differing animation at spawn)
* <tt>"fix_barrel"</tt> - Re-orient a wayward muzzle joint
* <tt>"invert_pitch"</tt> - Flips the pitching behaviour of the IK

=== sdVehicleJointAimer ===

This aims a single joint at the player's target.

'''Keys:'''
* <tt>"joint"</tt> - Joint to be aimed
* <tt>"weapon2"</tt> - Allows a second weapon to be associated with the IK, so that it also aims the joint when that weapon is in use.

=== sdVehicleIK_Steering ===

This IK is used to keep the player's hand joints attached to two joints on the vehicle - for example a steering wheel, or the handlebars of the Husky.

'''Keys:'''
* <tt>"joint_left"</tt> - The joint the left hand should be attached to
* <tt>"joint_right"</tt> - The joint the right hand should be attached to

= Suspension IK =

== Introduction ==

Vehicle <tt>wheel</tt> & <tt>suspension</tt> parts can have a string map associated with them to give them IK. This allows joints to be specially animated, for example wishbone suspension or landing legs. They are provided with information from the vehicle part about the length of the suspension, and the suspension IK manipulate joints to make it look like the vehicle is reacting to the changing length.

== Types ==

There are a number of different IK types that can be used, each providing a different appearance. The type is selected with the <tt>"type"</tt> key of the string map. The types of IK are listed below.

=== <tt>"pivot"</tt> ===

In this system the suspension offset is achieved by rotating a single joint.

'''Keys:'''
* <tt>"joint"</tt> - The joint that is rotated
* <tt>"reverse"</tt> - Reverses the response to the changing length

=== <tt>"double_wishbone"</tt> ===

This system rotates two joints, an upper joint and a lower joint.

'''Keys:'''
* <tt>"joint_upper"</tt> - The upper joint to be rotated
* <tt>"joint_lower"</tt> - The lower joint to be rotated
* <tt>"lerp_scale"</tt> - How quickly the system responds to changes in suspension length. <tt>1</tt> means it will instantly reach the new position, <tt>0</tt> means it will never respond. Defaults to <tt>0.5</tt>.

=== <tt>"vertical"</tt> ===

This type simply moves a single joint up and down as the suspension length changes.

'''Keys:'''
* <tt>"joint"</tt> - The joint to be moved up and down.

=== <tt>"2jointleg"</tt> ===

This type rotates two joints - a "hip" joint and a "knee" joint.

'''Keys:'''
* <tt>"joint_hip"</tt> - The hip joint.
* <tt>"joint_knee"</tt> - The knee joint.
* <tt>"dir_hip"</tt> - The direction (in the local space of the vehicle) the hip should rotate in. Defaults to <tt>"0 0 1"</tt>
* <tt>"lerp_scale"</tt> - How quickly the system responds to changes in suspension length. <tt>1</tt> means it will instantly reach the new position, <tt>0</tt> means it will never respond. Defaults to <tt>0.5</tt>.
* <tt>"reverse"</tt> - Reverses the response to the changing length

[[Category:Vehicles]]

</noinclude>

Vehicle Scripting: IK

2007-12-04T17:48:10Z

JRAD: /* sdVehicleWeaponAimer */

Describes IK used for vehicle positions and suspension.<includeonly>

{{main|Vehicle Scripting: IK}}</includeonly><noinclude>

= Vehicle Position IK =

== Introduction ==

Inverse kinematic (IK) systems can be added to vehicles, allowing joints to be manipulated based on the player's view direction, amongst other things. For example aiming a weapon by rotating a turret and elevating a barrel, or keeping the player's hands on the steering wheel.

IK systems are added within positionDef blocks in the vehicleDef.

Properties:
* <tt>name</tt> - the name of the IK system, to identify it in the code.
* <tt>type</tt> - the code class to use, defines the behaviour of the IK system. Types detailed below.
* <tt>parms</tt> - a block of key/value pairs, providing the parameters to the code class.

The IK systems can also have pitch & yaw clamps. '''TODO: FLESH THIS OUT'''

== Types ==

=== Common ===

One key is common to all the IK types:
* <tt>"weapon"</tt> - The name of the weapon associated with this IK. The player using this weapon is the player that will govern the IK. If not specified then the player in the position is the one that governs the IK. The name used here should be the value of the <tt>"weapon_name"</tt> key in the stringMap of the desired weapon.

=== sdVehicleIKArms ===

This is used for weapons that are in an arm-like configuration - for example a gun on a tripod.

'''Keys:'''
* <tt>"jointElbow"</tt> - Joint that is yawed to aim
* <tt>"jointWrist"</tt> - Joint that is pitched to aim - this should be down the hierarchy from <tt>"jointElbow"</tt>
* <tt>"jointMuzzle"</tt> - Joint that needs to be pointed at the target - eg the muzzle of the weapon. This should be down the hierarchy from jointMuzzle.
* <tt>"pitchAxis"</tt> - Selects which axis of the wrist joint is rotated to pitch towards the target.
*: 1 = x-axis, 2 = y-axis, 3 = z-axis. Making this value negative reverses the direction of the pitch.
*: Defaults to 2.

=== sdVehicleSwivel===

This IK type simply rotates the joint with the aim of the player associated.

'''Keys'''
* <tt>"joint"</tt> - The joint to be rotated.

=== sdVehicleWeaponAimer ===

This IK attempts to aim the muzzle joint at the player's target. This is the form of IK integrated into the <tt>sdVehicleWeaponFixedMinigun</tt> weapon type, with differing key names. '''TODO: Flesh this out more.'''

'''Keys:'''
* <tt>"jointShoulder"</tt> - Base joint for the aiming. If not specified, the parent joint of the elbow is used.
* <tt>"jointElbow"</tt> - Joint that is yawed to aim
* <tt>"jointWrist"</tt> - Joint that is pitched to aim - this should be down the hierarchy from <tt>"jointElbow"</tt>
* <tt>"jointMuzzle"</tt> - Joint that needs to be pointed at the target - eg the muzzle of the weapon. This should be down the hierarchy from jointMuzzle.
* <tt>"deployed_anim"</tt> - Animation that is used to gather initial calibration parameters (for models that have a differing animation at spawn)
* <tt>"fix_barrel"</tt> - Re-orient a wayward muzzle joint
* <tt>"invert_pitch"</tt> - Flips the pitching behaviour of the IK

=== sdVehicleJointAimer ===

This aims a single joint at the player's target.

'''Keys:'''
* <tt>"joint"</tt> - Joint to be aimed
* <tt>"weapon2"</tt> - Allows a second weapon to be associated with the IK, so that it also aims the joint when that weapon is in use.

=== sdVehicleIK_Steering ===

This IK is used to keep the player's hand joints attached to two joints on the vehicle - for example a steering wheel, or the handlebars of the Husky.

'''Keys:'''
* <tt>"joint_left"</tt> - The joint the left hand should be attached to
* <tt>"joint_right"</tt> - The joint the right hand should be attached to

= Suspension IK =

== Introduction ==

Vehicle <tt>wheel</tt> & <tt>suspension</tt> parts can have a string map associated with them to give them IK. This allows joints to be specially animated, for example wishbone suspension or landing legs. They are provided with information from the vehicle part about the length of the suspension, and the suspension IK manipulate joints to make it look like the vehicle is reacting to the changing length.

== Types ==

There are a number of different IK types that can be used, each providing a different appearance. The type is selected with the <tt>"type"</tt> key of the string map. The types of IK are listed below.

=== <tt>"pivot"</tt> ===

In this system the suspension offset is achieved by rotating a single joint.

'''Keys:'''
* <tt>"joint"</tt> - The joint that is rotated
* <tt>"reverse"</tt> - Reverses the response to the changing length

=== <tt>"double_wishbone"</tt> ===

This system rotates two joints, an upper joint and a lower joint.

'''Keys:'''
* <tt>"joint_upper"</tt> - The upper joint to be rotated
* <tt>"joint_lower"</tt> - The lower joint to be rotated
* <tt>"lerp_scale"</tt> - How quickly the system responds to changes in suspension length. <tt>1</tt> means it will instantly reach the new position, <tt>0</tt> means it will never respond. Defaults to <tt>0.5</tt>.

=== <tt>"vertical"</tt> ===

This type simply moves a single joint up and down as the suspension length changes.

'''Keys:'''
* <tt>"joint"</tt> - The joint to be moved up and down.

=== <tt>"2jointleg"</tt> ===

This type rotates two joints - a "hip" joint and a "knee" joint.

'''Keys:'''
* <tt>"joint_hip"</tt> - The hip joint.
* <tt>"joint_knee"</tt> - The knee joint.
* <tt>"dir_hip"</tt> - The direction (in the local space of the vehicle) the hip should rotate in. Defaults to <tt>"0 0 1"</tt>
* <tt>"lerp_scale"</tt> - How quickly the system responds to changes in suspension length. <tt>1</tt> means it will instantly reach the new position, <tt>0</tt> means it will never respond. Defaults to <tt>0.5</tt>.
* <tt>"reverse"</tt> - Reverses the response to the changing length

[[Category:Vehicles]]

</noinclude>

Texture Editor

2007-11-21T18:01:37Z

JRAD: /* Finding a texture: The Media Inspector */

== Finding a texture: The Media Inspector ==
[[Image:media_insp.jpg|frame|left|Media Inspector]]

The first step in texturing a brush or patch mesh is to select a texture.
In this example {{filename|base\texturesheets\valley\valley_wall_10_ts_d}} is used.
Textures are selected in the '''Media Inspector'''.
Browse to the directory where the texture is stored and highlight it.
* Using the {{accelkey|arrow keys}} you can step down through the available textures which will be displayed in the lit texure window of the '''Media Inspector'''.
* You can zoom in and out of the texture by dragging {{accelkey|shift}}{{accelbtn|rmb}} left and right.
* The image in the texture preview window of the '''Media Inspector''' can be shifted by {{accelbtn|rmb}}-dragging. These can be useful when dealing with texture sheets which can be quite tall.
* If you know the name of the texture you want to use, typing its name in the filter will allow the inspector to show only materials with this text in it.

{{clear}}

== Viewing a texture: The Textures Inspector ==
[[Image:textures_insp.jpg|frame|left|Textures Inspector]]
Selecting a texture in the '''Media Inspector''' places it in the '''Textures Inspector'''. From here it can be applied to a brush or patch mesh.

The '''Textures Inspector''' displays textures in a 2D view.
* Texture directories are indicated and can be collapsed by pressing it's name. This can be useful if there are a lot of textures used.
* The currently selected texture is highlighted with a red box.
* The 2Dtexture view can be scaled by pressing {{accelkey|alt}} and {{accelbtn|rmb}} and moving the mouse left or right. This view can also be scrolled by holding '{{accelbtn|rmb}} and moving the mouse up or down or using the {{accelbtn|mouse wheel}}.
* You can add often used textures such as Caulk to a favourites panel at the bottom of the '''Textures Inspector''' by pressing the {{accelbtn|rmb}} over the texture and selecting "Add to favourites" from the menu.
* If you know the name of the texture you want to use, typing it's name in the filter will allow the inspector to show only materials with this name
* It is possible to further filter textures by using the options in the "Materials" menu of editworld. From here you can Show/Hide all textures which have been selected in the '''Media Inspector''', or show only those textures in use in the map.
* To view the material for a texture, press {{accelbtn|rmb}} over the texture and select "View material" from the menu.

To apply a texture, select the brush, face, or patch and highlight the required texture in the Textures Inspector.

{{clear}}

== Texturing using the Texture Editor ==
[[Image:texture_editor_insp.jpg|frame|left|Texture Editor Inspector]]

Once a texture is applied to the face of a brush it must be aligned to fit correctly to that face. This can be done numerically in the '''Surfaces Inspector''' (as with in previous versions of Radiant) by using the shift, fit, scale and rotate options.

* Note: if using the '''Surfaces Inspector''' for texturing it is useful to note that by activating any numerical field by highlighting it's value in the inspector, you can use the {{accelbtn|mouse wheel}} to shift, scale or rotate by the amount indicated.

When texturing objects with [[Texturesheets]] it is often the case that only part of that texture is required to be fitted exactly to a face. It is possible to do this using the '''Surfaces Inspector''' but it is much more convenient to use the '''Texture Editor Inspector'''.

Once applied, the texture on a selected face appears in the '''Texture Editor Inspector'''. The region of the texture which will be applied to the selected face is highlighted by the red box. This is the texture region and it's size in game units is indicated in the texture view.
Textures appear tiled in the texture view. In the centre, one instance of the texture is lit and surrounded by a white box.

The scale and position of the texture region can be altered either numerically in the bounds section (based around the origin of the red region box which is it's bottom left corner) or by using the mouse to scale/shift the texture region box in the texture window. It's important to note that this inspector is used to fit the texture to the face and is not an indication of the uv's of that face. So for example if you fit a texture using the '''Texture Editor Inspector''' and then shift it on the brush face using the '''Surfaces Inspector''' the texture region box will not update to indicate this.
Double clicking in the red box will reset the texture region scale and position to that indicated by the red box.

* Note: The movement/scaling amount of the texture region is defined by the grid size. So for example, for very precise shifts or scales of the texture region use lower grid sizes. These can be changed using the number keys.

[[Category:Basic Level Design]]

Generating Compiled Scripts

2007-11-21T16:24:42Z

JRAD:

==Overview==
Compiled scripts are automatically generated from the game's interpreted script files. They use less memory, and run more quickly than interpreted scripts. Interpreted scripts have the advantage of quick turnaround when developing. For a final release of a mod, you should consider using compiled scripts.

==Exporting the Scripts==
Start the game up, and when it has finished loading and you are at the main menu, bring down the console and enter "exportScript", minus the quotes. Make sure to check there are no errors on the console. If there are none, you can exit the game.

This process will have added several .cpp and .h files to "base/src".

==Compiling the Scripts==
Open the "base/src/base" folder. Inside this folder is a file called "compiledscriptx86.sln", which you can open with Visual Studio.

Once opened, there should be a drop down box on the toolbar, ensure this is set to "Release". After this, select "Build Solution" from the "Build" menu. Once completed the build console should state that is is completed with 0 errors and warnings.

If not, you should seek a programmer's help.The most likely case for this happening is that the project file is out of date when someone has added or removed a script class, but this should not be a common occurrence.

==After Compiling the Scripts==
Assuming the compile process has completed successfully, you can find your compiled script DLL in base/src/base/build/win32/release/. Copy CompiledScriptx86.dll to your mod's base folder.

==Using Compiled Scripts==
After you've placed CompiledScriptx86.dll where the game can find it, ensure that g_useCompiledScript is set to 1 before loading a map. The game should automatically load your custom script dll.

Generating Compiled Scripts

2007-11-21T16:23:36Z

JRAD:

==Overview==
Compiled scripts are automatically generated from the game's interpreted script files. They use less memory, and run more quickly than interpreted scripts. Interpreted scripts have the advantage of quick turnaround when developing. For a final release of a mod, you should consider using compiled scripts.

==Exporting the Scripts==
Start the game up, and when it has finished loading and you are at the main menu, bring down the console and enter "exportScript", minus the quotes. Make sure to check there are no errors on the console. If there are none, you can exit the game.

This process will have added several .cpp and .h files to "base/src".

==Compiling the Scripts==
Open the "base/src/base" folder. Inside this folder is a file called "compiledscriptx86.sln", which you can open with Visual Studio. Once opened, there should be a drop down box on the toolbar, ensure this is set to "Release". After this, select "Build Solution" from the "Build" menu. Once completed the build console should state that is is completed with 0 errors and warnings. If not, you should seek a programmer's help. The most likely case for this happening is that the project file is out of date when someone has added or removed a script class, but this should not be a common occurance.

==After Compiling the Scripts==
Assuming the compile process has completed successfully, you can find your compiled script DLL in base/src/base/build/win32/release/. Copy CompiledScriptx86.dll to your mod's base folder.

==Using Compiled Scripts==
After you've placed CompiledScriptx86.dll where the game can find it, ensure that g_useCompiledScript is set to 1 before loading a map. The game should automatically load your custom script dll.

Generating Compiled Scripts

2007-11-21T16:23:28Z

JRAD:

==Overview==
Compiled scripts are automatically generated from the game's interpreted script files. They use less memory, and run more quickly than interpreted scripts. Interpreted scripts have the advantage of quick turnaround when developing. For a final release of a mod, you should consider using compiled scripts.

==Exporting the Scripts==
Start the game up, and when it has finished loading and you are at the main menu, bring down the console and enter "exportScript", minus the quotes. Make sure to check there are no errors on the console. If there are none, you can exit the game.

This process will have added several .cpp and .h files to "base/src".

==Compiling the Scripts==
Open the "base/src/base" folder. Inside this folder is a file called "compiledscriptx86.sln", which you can open with Visual Studio. Once opened, there should be a drop down box on the toolbar, ensure this is set to "Release". After this, select "Build Solution" from the "Build" menu. Once completed the build console should state that is is completed with 0 errors and warnings. If not, you should seek a programmer's help. The most likely case for this happening is that the project file is out of date when someone has added or removed a script class, but this should not be a common occurance.

==After Compiling the Scripts==
Assuming the compile process has completed successfully, you can find your compiled script DLL in base/src/base/build/win32/release/. Copy CompiledScriptx86.dll to your mod's base folder.

==Using Compiled Scripts==
After you've placed CompiledScriptx86.dll where the game can find it, ensure that g_useCompiledScript is set to 1 before loading a map. The game should automatically load your custom script dll.

Generating Compiled Scripts

2007-11-21T16:23:14Z

JRAD:

==Compiled Scripts==
Compiled scripts are automatically generated from the game's interpreted script files. They use less memory, and run more quickly than interpreted scripts. Interpreted scripts have the advantage of quick turnaround when developing. For a final release of a mod, you should consider using compiled scripts.

==Exporting the Scripts==
Start the game up, and when it has finished loading and you are at the main menu, bring down the console and enter "exportScript", minus the quotes. Make sure to check there are no errors on the console. If there are none, you can exit the game.

This process will have added several .cpp and .h files to "base/src".

==Compiling the Scripts==
Open the "base/src/base" folder. Inside this folder is a file called "compiledscriptx86.sln", which you can open with Visual Studio. Once opened, there should be a drop down box on the toolbar, ensure this is set to "Release". After this, select "Build Solution" from the "Build" menu. Once completed the build console should state that is is completed with 0 errors and warnings. If not, you should seek a programmer's help. The most likely case for this happening is that the project file is out of date when someone has added or removed a script class, but this should not be a common occurance.

==After Compiling the Scripts==
Assuming the compile process has completed successfully, you can find your compiled script DLL in base/src/base/build/win32/release/. Copy CompiledScriptx86.dll to your mod's base folder.

==Using Compiled Scripts==
After you've placed CompiledScriptx86.dll where the game can find it, ensure that g_useCompiledScript is set to 1 before loading a map. The game should automatically load your custom script dll.

Enemy Territory: QUAKE Wars

2007-11-21T16:10:00Z

JRAD: /* Coding */

Welcome to the Enemy Territory: QUAKE Wars section. Here you'll find a variety of reference documentation and tutorials related to editing ETQW, along with links to the SDK. To learn more about Enemy Territory: QUAKE Wars, visit [http://www.enemyterritory.com www.enemyterritory.com].

==Software Development Kit==

The Enemy Territory: QUAKE Wars Software Development kit is currently in BETA. A list of download locations is [http://community.enemyterritory.com available here].

==Tutorials==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Basics ===
|-
|
* '''[[Taking A Screenshot]]''' - Settings and options for making a great screenshot!
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Terrain ===
|-
|
* '''[[Making a Terrain Model]]''' - Create a terrain mesh for your map.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Vehicles ===
|-
|
* '''[[Vehicle Tutorial]]''' - The whole thing! Click below for smaller segments.
** '''[[Vehicle Tutorial Part 1|Step 1]]''' - Design considerations, before you do anything else!
** '''[[Vehicle Tutorial Part 2|Step 2]]''' - Initial rough model, rig and basic script.
** '''[[Vehicle Tutorial Part 3|Step 3]]''' - More advanced rig and scripting.
** '''[[Vehicle Tutorial Part 4|Step 4]]''' - Further technical setup ideas.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models & Textures ===
|-
|
* '''[[Making A Normal Map]]''' - Using Renderbump to generate a bump-map from a high-poly model.
|-
|}
|}

==Script & Code==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Coding ===
|-
|
* '''[[Windows Code Notes]]''' - General information about compiling on Windows.
* '''[[Linux Code Notes]]''' - General information about compiling on Linux systems.
* '''[[Generating Compiled Scripts]]''' - Information on building a compiledscript DLL.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Declarations ===
|-
|
* '''[[Materials]]''' - All you need to know about material declarations.
* '''[[Templates]]''' - Setting up templates to save time and effort.
* '''[[Surface Types]]''' - Available surface types for particle & sound effects.
* '''[[Skins]]''' - Easily switch textures on surfaces.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Vehicle Scripting ===
|-
|
* '''[[Vehicle Scripting: Basic_Overview|Basic Overview]]''' - Introduction to vehicle setup.
* '''[[Vehicle Scripting: Entity_Definition|Entity Definition]]''' - One definition to rule them all!
* '''[[Vehicle Scripting: Vehicle_Definition|Vehicle Definition]]''' - Introduction to the ''.vscript'' file.
* '''[[Vehicle Scripting: Positions_&_Views|Positions & Views]]''' - Configuring player positions & camera views.
* '''[[Vehicle Scripting: Components|Components]]''' - Details of various vehicle components.
* '''[[Vehicle Scripting: Weapons|Weapons]]''' - Things that go boom!
* '''[[Vehicle Scripting: IK|IK]]''' - Inverse Kinematics & you...
* '''[[Vehicle Scripting: Cockpits|Cockpits]]''' - Cockpit setup.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Entity Scripting ===
|-
|
* '''[[EntityClass:Overview|Classes]]''' - Tree of entity types.
* '''[[ScriptEvent:List|Events]]''' - List of all script events.
* '''[[Scripting:Examples|Examples]]''' - Some example walkthoughs of building up a scripted entity.
* '''[[Script:Files|Script Files]]''' - List of the script files used by the game.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== GUIs ===
|-
|
* '''[[GUIs|GUI Overview]]''' - Overview of the GUI system.
* '''[[GUIs: Event Based Scripting|Event Based Scripting]]''' - GUIs are event-based.
* '''[[GUIs: Materials|Materials]]''' - Using materials in GUIs.
* '''[[GUIs: Transitions|Transitions]]''' - Transitions.
* '''[[GUIs: Templates|Templates]]''' - Using templates in GUIs.
* '''[[GUIs: List Enumeration|List Enumeration]]''' - List enumerations.
* '''[[GUIs: Properties|Properties]]''' - Player/Global properties and more.
* '''[[GUIs: Timelines|Timelines]]''' - GUI timelines.
* '''[[GUIs: Layouts|Layouts]]''' - Window layouts.
* '''[[Reference (GUIs)|Reference]]''' - GUI reference.
|-
|}
|}

==Design==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== The Basics ===
|-
|
* '''[[A guide to your first map]]'''
* '''[[Ambient Light Editor]]'''
* '''[[Atmosphere Editor]]'''
* '''[[Brush Basics]]'''
* '''[[Common Textures]]'''
* '''[[Decals]]'''
* '''[[Editor Groups]]'''
* '''[[Entity Basics]]'''
* '''[[Lighting Basics]]'''
* '''[[Map Objects]]'''
* '''[[Portal Basics]]'''
* '''[[References]]'''
* '''[[Sound]]'''
* '''[[Texture Editor]]'''
----
* '''[[Design: How do I|How do I ...?]]''' - Common and useful tasks
* '''[[Design: Troubleshooting|Troubleshooting]]''' - Common problems and fixes
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Advanced Stuff ===
|-
|
* '''[[Batches]]'''
* '''[[Deployables]]'''
* '''[[Developer cheats]]'''
* '''[[List of Entities]]''' - Descriptions for all entities
* '''[[LOD Groups]]'''
* '''[[Locations]]'''
* '''[[Model Instancing]]'''
* '''[[Occlusion Tests]]'''
* '''[[Vehicle Route Constraint System]]'''
|-
|}
|}

==Art==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models ===
|-
|
* '''[[In-Game Models]]''' - Making models for use in the engine.
* '''[[High-Poly Models]]''' - Making source models for baking normal maps.
* '''[[Renderbump]]''' - Create normal maps from high-poly geometry.
* '''[[Imposters]]''' - Sprites used for rendering complex models cheaply at a distance.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Animation ===
|-
|
* '''[[MD5 Export Process]]''' - How to export an animated MD5.
* '''[[Vehicle Setup]]''' - How to set up a vehicle.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Textures ===
|-
|
* '''[[Basic Texture Overview]]''' - Supported texture types and implementations.
* '''[[Texturesheets]]''' - Overview of what texturesheets are, and when to use them.
* '''[[The Atlas Editor]]''' - Create environment texture sheets to improve performance.
* '''[[RenderBumpFlat]]''' - Create normal-maps from high-poly geometry.
* '''[[Detail Textures]]''' - Add high-frequency detail to your textures.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Terrain Editing ===
|-
|
* '''[[Making a Terrain Model]]''' - Create a terrain mesh for your map.
* '''[[Terrain Editor|EditWorld's Terrain Editor]]''' - Set up a Surface Tree for your MegaTexture.
* '''[[MegaBuild]]''' - Render and compile your MegaTexture.
* '''[[Water Surfaces#Water Models|Water Surfaces]]''' - Create water to go with your landscape.
* '''[[STUFF System]]''' - Procedurally distribute models over your terrain mesh.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Atmospheres and Effects ===
|-
|
* '''[[Atmosphere Editor|The Atmosphere Editor]]''' - Create and edit atmospheres for your map.
* '''[[Ambient Light Editor|The Ambient Light Editor]]''' - Create and edit ambient light setups.
* '''[[Environment Maps]]''' - Used for reflection effects.
* '''[[Water Surfaces]]''' - Creating water effects.
* '''[[Effects Editor|The Effects Editor]]''' - Create and edit particle effects.
* '''[[Cheap Decals]]''' - Bulletholes and other collision decals.
|-
|}
|}

Windows Code Notes

2007-11-21T16:07:44Z

JRAD: /* Build Environments */

==Build Environment==
You can use the free Visual Studio 2005 Express edition to compile the SDK. ''Please note that the newly-released Visual Studio 2008 Express is currently untested with the SDK.''

==Running the Game==
You can find the final gamex86.dll in '''source\build\win32\<configuration name>\'''
Copy it to the same folder as your etqw.exe and the game will automatically load your new dll.

We recommend setting up a post-build event to automatically copy the dll to the game folder.

==Project Configurations==
The game project has three configurations:
===Debug with Edit and Continue===
Disable all optimizations and enable Edit and Continue so that code can be modified and the changes applied without restarting the game. Some operations like compiling scripts will take noticeably longer in this mode.

===Debug with Inlines===
Optimizations are enabled; some functions will be inlined. You'll still be able to properly set breakpoints and inspect data.

===Release===
All Optimizations are enabled. Breakpoints and data may not reliably match up to the source code.

Windows Code Notes

2007-11-21T16:07:33Z

JRAD: /* Build Environments */

==Build Environments==
You can use the free Visual Studio 2005 Express edition to compile the SDK. ''Please note that the newly-released Visual Studio 2008 Express is currently untested with the SDK.''

==Running the Game==
You can find the final gamex86.dll in '''source\build\win32\<configuration name>\'''
Copy it to the same folder as your etqw.exe and the game will automatically load your new dll.

We recommend setting up a post-build event to automatically copy the dll to the game folder.

==Project Configurations==
The game project has three configurations:
===Debug with Edit and Continue===
Disable all optimizations and enable Edit and Continue so that code can be modified and the changes applied without restarting the game. Some operations like compiling scripts will take noticeably longer in this mode.

===Debug with Inlines===
Optimizations are enabled; some functions will be inlined. You'll still be able to properly set breakpoints and inspect data.

===Release===
All Optimizations are enabled. Breakpoints and data may not reliably match up to the source code.

Windows Code Notes

2007-11-21T16:07:21Z

JRAD: /* Build Environments */

==Build Environments==
You can use the free Visual Studio 2005 Express edition to compile the SDK. ''Please note that the newly-released Visual Studio 2008 Express is currently untested.''

==Running the Game==
You can find the final gamex86.dll in '''source\build\win32\<configuration name>\'''
Copy it to the same folder as your etqw.exe and the game will automatically load your new dll.

We recommend setting up a post-build event to automatically copy the dll to the game folder.

==Project Configurations==
The game project has three configurations:
===Debug with Edit and Continue===
Disable all optimizations and enable Edit and Continue so that code can be modified and the changes applied without restarting the game. Some operations like compiling scripts will take noticeably longer in this mode.

===Debug with Inlines===
Optimizations are enabled; some functions will be inlined. You'll still be able to properly set breakpoints and inspect data.

===Release===
All Optimizations are enabled. Breakpoints and data may not reliably match up to the source code.

Windows Code Notes

2007-11-21T16:06:59Z

JRAD:

==Build Environments==
You can use Visual Studio 2005 Express edition to compile the SDK. ''Please note that the newly-released Visual Studio 2008 Express is currently untested.''

==Running the Game==
You can find the final gamex86.dll in '''source\build\win32\<configuration name>\'''
Copy it to the same folder as your etqw.exe and the game will automatically load your new dll.

We recommend setting up a post-build event to automatically copy the dll to the game folder.

==Project Configurations==
The game project has three configurations:
===Debug with Edit and Continue===
Disable all optimizations and enable Edit and Continue so that code can be modified and the changes applied without restarting the game. Some operations like compiling scripts will take noticeably longer in this mode.

===Debug with Inlines===
Optimizations are enabled; some functions will be inlined. You'll still be able to properly set breakpoints and inspect data.

===Release===
All Optimizations are enabled. Breakpoints and data may not reliably match up to the source code.

Windows Code Notes

2007-11-21T16:02:06Z

JRAD:

*You can use Visual Studio 2005 Express edition to compile the SDK.
*Visual Studio 2008 Express is currently untested.

*You can find the final gamex86.dll in '''source\build\win32\<configuration name>\'''
**Copy it to the same folder as your etqw.exe and the game will automatically load your new dll.

*We recommend setting up a post-build event to automatically copy the dll to the game folder.

Windows Code Notes

2007-11-21T16:00:57Z

JRAD:

*You can use Visual Studio 2005 Express edition to compile the SDK.
*Visual Studio 2008 Express is currently untested.

*You can find the final gamex86.dll in source\build\win32\<configuration name>\
**Copy it to the same folder as your etqw.exe and the game will automatically load your new dll.

*We recommend setting up a post-build event to automatically copy the dll to the game folder.

Enemy Territory: QUAKE Wars

2007-11-21T15:59:39Z

JRAD: /* Script & Code */

Welcome to the Enemy Territory: QUAKE Wars section. Here you'll find a variety of reference documentation and tutorials related to editing ETQW, along with links to the SDK. To learn more about Enemy Territory: QUAKE Wars, visit [http://www.enemyterritory.com www.enemyterritory.com].

==Software Development Kit==

The Enemy Territory: QUAKE Wars Software Development kit is currently in BETA. A list of download locations is [http://community.enemyterritory.com available here].

==Tutorials==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Basics ===
|-
|
* '''[[Taking A Screenshot]]''' - Settings and options for making a great screenshot!
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Terrain ===
|-
|
* '''[[Making a Terrain Model]]''' - Create a terrain mesh for your map.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Vehicles ===
|-
|
* '''[[Vehicle Tutorial]]''' - The whole thing! Click below for smaller segments.
** '''[[Vehicle Tutorial Part 1|Step 1]]''' - Design considerations, before you do anything else!
** '''[[Vehicle Tutorial Part 2|Step 2]]''' - Initial rough model, rig and basic script.
** '''[[Vehicle Tutorial Part 3|Step 3]]''' - More advanced rig and scripting.
** '''[[Vehicle Tutorial Part 4|Step 4]]''' - Further technical setup ideas.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models & Textures ===
|-
|
* '''[[Making A Normal Map]]''' - Using Renderbump to generate a bump-map from a high-poly model.
|-
|}
|}

==Script & Code==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Coding ===
|-
|
* '''[[Windows Code Notes]]''' - General information about compiling on Windows.
* '''[[Linux Code Notes]]''' - General information about compiling on Linux systems.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Declarations ===
|-
|
* '''[[Materials]]''' - All you need to know about material declarations.
* '''[[Templates]]''' - Setting up templates to save time and effort.
* '''[[Surface Types]]''' - Available surface types for particle & sound effects.
* '''[[Skins]]''' - Easily switch textures on surfaces.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Vehicle Scripting ===
|-
|
* '''[[Vehicle Scripting: Basic_Overview|Basic Overview]]''' - Introduction to vehicle setup.
* '''[[Vehicle Scripting: Entity_Definition|Entity Definition]]''' - One definition to rule them all!
* '''[[Vehicle Scripting: Vehicle_Definition|Vehicle Definition]]''' - Introduction to the ''.vscript'' file.
* '''[[Vehicle Scripting: Positions_&_Views|Positions & Views]]''' - Configuring player positions & camera views.
* '''[[Vehicle Scripting: Components|Components]]''' - Details of various vehicle components.
* '''[[Vehicle Scripting: Weapons|Weapons]]''' - Things that go boom!
* '''[[Vehicle Scripting: IK|IK]]''' - Inverse Kinematics & you...
* '''[[Vehicle Scripting: Cockpits|Cockpits]]''' - Cockpit setup.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Entity Scripting ===
|-
|
* '''[[EntityClass:Overview|Classes]]''' - Tree of entity types.
* '''[[ScriptEvent:List|Events]]''' - List of all script events.
* '''[[Scripting:Examples|Examples]]''' - Some example walkthoughs of building up a scripted entity.
* '''[[Script:Files|Script Files]]''' - List of the script files used by the game.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== GUIs ===
|-
|
* '''[[GUIs|GUI Overview]]''' - Overview of the GUI system.
* '''[[GUIs: Event Based Scripting|Event Based Scripting]]''' - GUIs are event-based.
* '''[[GUIs: Materials|Materials]]''' - Using materials in GUIs.
* '''[[GUIs: Transitions|Transitions]]''' - Transitions.
* '''[[GUIs: Templates|Templates]]''' - Using templates in GUIs.
* '''[[GUIs: List Enumeration|List Enumeration]]''' - List enumerations.
* '''[[GUIs: Properties|Properties]]''' - Player/Global properties and more.
* '''[[GUIs: Timelines|Timelines]]''' - GUI timelines.
* '''[[GUIs: Layouts|Layouts]]''' - Window layouts.
* '''[[Reference (GUIs)|Reference]]''' - GUI reference.
|-
|}
|}

==Design==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== The Basics ===
|-
|
* '''[[A guide to your first map]]'''
* '''[[Ambient Light Editor]]'''
* '''[[Atmosphere Editor]]'''
* '''[[Brush Basics]]'''
* '''[[Common Textures]]'''
* '''[[Decals]]'''
* '''[[Editor Groups]]'''
* '''[[Entity Basics]]'''
* '''[[Lighting Basics]]'''
* '''[[Map Objects]]'''
* '''[[Portal Basics]]'''
* '''[[References]]'''
* '''[[Sound]]'''
* '''[[Texture Editor]]'''
----
* '''[[Design: How do I|How do I ...?]]''' - Common and useful tasks
* '''[[Design: Troubleshooting|Troubleshooting]]''' - Common problems and fixes
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Advanced Stuff ===
|-
|
* '''[[Batches]]'''
* '''[[Deployables]]'''
* '''[[Developer cheats]]'''
* '''[[List of Entities]]''' - Descriptions for all entities
* '''[[LOD Groups]]'''
* '''[[Locations]]'''
* '''[[Model Instancing]]'''
* '''[[Occlusion Tests]]'''
* '''[[Vehicle Route Constraint System]]'''
|-
|}
|}

==Art==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models ===
|-
|
* '''[[In-Game Models]]''' - Making models for use in the engine.
* '''[[High-Poly Models]]''' - Making source models for baking normal maps.
* '''[[Renderbump]]''' - Create normal maps from high-poly geometry.
* '''[[Imposters]]''' - Sprites used for rendering complex models cheaply at a distance.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Animation ===
|-
|
* '''[[MD5 Export Process]]''' - How to export an animated MD5.
* '''[[Vehicle Setup]]''' - How to set up a vehicle.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Textures ===
|-
|
* '''[[Basic Texture Overview]]''' - Supported texture types and implementations.
* '''[[Texturesheets]]''' - Overview of what texturesheets are, and when to use them.
* '''[[The Atlas Editor]]''' - Create environment texture sheets to improve performance.
* '''[[RenderBumpFlat]]''' - Create normal-maps from high-poly geometry.
* '''[[Detail Textures]]''' - Add high-frequency detail to your textures.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Terrain Editing ===
|-
|
* '''[[Making a Terrain Model]]''' - Create a terrain mesh for your map.
* '''[[Terrain Editor|EditWorld's Terrain Editor]]''' - Set up a Surface Tree for your MegaTexture.
* '''[[MegaBuild]]''' - Render and compile your MegaTexture.
* '''[[Water Surfaces#Water Models|Water Surfaces]]''' - Create water to go with your landscape.
* '''[[STUFF System]]''' - Procedurally distribute models over your terrain mesh.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Atmospheres and Effects ===
|-
|
* '''[[Atmosphere Editor|The Atmosphere Editor]]''' - Create and edit atmospheres for your map.
* '''[[Ambient Light Editor|The Ambient Light Editor]]''' - Create and edit ambient light setups.
* '''[[Environment Maps]]''' - Used for reflection effects.
* '''[[Water Surfaces]]''' - Creating water effects.
* '''[[Effects Editor|The Effects Editor]]''' - Create and edit particle effects.
* '''[[Cheap Decals]]''' - Bulletholes and other collision decals.
|-
|}
|}

GUIs: Properties

2007-11-21T12:27:46Z

JRAD:

<noinclude>== Overview ==</noinclude>
Global properties can be accessed from anywhere in the GUI and is used for communicating with the gamecode and game scripts.<includeonly>

{{main|GUIs: Properties}}</includeonly><noinclude>

The global properties have been grouped together into a few groups:
* Player properties - Anything relating to the player.
* Limbo properties - Limbo menu properties should only used in the limbo menu.
* Admin properties - Used in the admin system tab in the limbo menu for enabling/disabling lists/buttons for the local player.
* Global properties - Communicating with the game scripts.
* SDNet properties - Used for session and account management.

== Player Properties ==
These properties are always read only and are always related to the local player or the local view player (the one you're spectating), see the [[PlayerProperties|reference]] for the specifics and a description for each of the properties

The type of properties found in this category are:
* Player - Health, view direction, XP, spectating, is dead, etc.
* Vehicle - in a vehicle, in siege mode, in third person, vehicle has been EMPed, etc.
* Weapon/Damage - ammo in clip, total ammo, last kill message,
* Fireteam/Missons - Last task received, task status, in a fireteam, is fireteam leader, etc.
* Match/Team - Team name, winning time, in warmup, current match time, etc.
* Voting properties
* Tooltip properties

'''Example''':

The health bar is set like this (in ''guis/game/hud/hud.gui''), the position property will continually be updated whenever the player health updates.
windowDef healthFill {
type progress;
properties {
float position = player.health / player.maxHealth;
...
}
...
}

== Limbo Properties ==
These properties are always read only. See the [[LimboProperties|limbo propereties reference]] for a reference of all the limbo properties.

'''Example''':
Whenever the limbo menu (in ''guis/game/limbo/limbo.gui'') is activated it saves the current team and class selection among other things:
gui limbo {
...
events {
onActivate {
...
// Read the immediate value of limbo.teamName.
teamSelection = immediate( limbo.teamName );
if( icompare( teamSelection, "spec" ) == false ) {
lastTeamSelection = immediate( teamSelection );
}

// Save the current class selection for the player.
classSelection = limbo.role;
...
}
...
}
...
}

== Admin Properties ==
These properties are always read only. See the [[AdminProperties|admin propereties reference]] for a reference of all the admin properties.

'''Example''':

The visibility of the bot options in the admin menu (in ''guis/game/limbo/tabpages/admin.include'') depends on if the ''admin.canAdjustBots'' property is true.
windowDef lytPlayComp {
type layoutVertical;
properties {
// Draw windows from bottom to top instead of top to bottom.
float flags = VLF_DRAW_REVERSED;
// Only visible if the player can adjust bot settings.
float visible = admin.canAdjustBots;
vec4 margins = 0, 0, 0, 0;
rect rect = 0, 0, gui.lytBotCommands.rect.w - $evalfloat( 2 * PADDING ), 100;
}
// Include all the bot settings.
#include <guis/common/bots.include>
}

== Global Properties ==
Found in ''guis/globals.gui'' these are mainly used for communicating between GUIs and to the game scripts. They may be set/modified from either the GUIs, gamecode or the game scripts.

There are a few categories of global properties:
* ''game'' - game is running or not
* ''gameHud'' - Many properties related to updating the HUD, updated from the game scripts.
* ''mcpObjective'' - MCP objective properties, updated from the game scripts.
* ''constructObjective'' - Constructible objective properties, updated from the game scripts.
* ''hackObjective'' - Hack objective properties, updated from the game scripts.
* ''docObjective'' - Carryable item objective properties, updated from the game scripts.
* ''goalObjective'' - Carryable item goal objective properties, updated from the game scripts.
* ''flyerhiveObjective'' - Flyer drone objective properties, updated from the game scripts.
* ''destroyObjective'' - Destructible objective properties, updated from the game scripts.
* ''weapons'' - Some weapon related properties like charge, is cooling, etc. Updated from the game scripts.
* ''armTool'' - arming tool. Updated from the game scripts.
* ''charge'' - Charge timer, updated from the game scripts.
* ''deployables'' - Deployable information, updated from the game scripts.
* ''vehicles'' - Vehicle information, updated from the game scripts.
* ''mapinfo'' - map/objective information updated by the game scripts.
* ''progressBar'' - Progress bar when liberating/arming/hacking, etc. Updated by the game scripts.
* ''messageBox'' - Used for messages boxes (connecting to a game, disconnected, etc.).
* ''introMovies'' - Intro movie properties.
* ''campaignInfo'' - Information about the campaign, updated from the gamecode.

These properties may be accessed like this:
globals.<category>.<property>
Like this used for checking if the data brain/briefcase is at home or not:
if ( globals.docObjective.state == CARRYABLE_ITEM_HOME ) {

''globals.gameHud.spawnHostActive'' is updated by the game scripts similar to this, where the GUI then makes sure to create/delete a notify icon on the HUD whenever the property changes:
void spawn_host::OnSpawnPointSelected( float isDefault ) {
SetupCommandmapIcon();

sys.setGUIFloat( GUI_GLOBALS_HANDLE, "gameHud.spawnHostActive", 1 );
}

== SDNet Properties ==
SDNet properties are related to the current user.
[[Category:GUIs]]

</noinclude>

Design: Troubleshooting

2007-11-21T12:22:39Z

JRAD:

This page serves as a list of common issues that you may encounter while creating or editing a map of your own. Solutions or workarounds are provided wherever possible. '''Bugs and bug reports do not belong here!''' If you encounter an issue that is not answered or listed on this page, you are advised to try one of the [[#Additional Resources|support sites]] for guidance. Alternatively, try the [[Talk:Level Design Troubleshooting|talk page]] for this topic.

* Note: This page assumes you are using the default key shortcuts.
* '''See also [[How do I]] page for a quick reference to common tasks.'''

== General Questions ==

=== How do I run the SDK? ===
After you've installed the ETQW SDK, you can launch it by running the 'SDK Launcher' shortcut from the Start Menu (it's usually found in 'Programs > id Software > Enemy Territory - QUAKE Wars(TM) SDK')

=== How do I configure the SDK Launcher? ===
The SDK Launcher requires a retail path and a save path. These should typically be the place where you installed ETQW, for example 'C:\Program Files\id Software\Enemy Territory - QUAKE Wars'

=== How do I launch the level editor, editWorld? ===
On the SDK Launcher, tick the 'editWorld' tickbox and then press 'Launch SDK'. This will load the game and it's built-in editor.

Alternatively, you can run the SDK build of the game and use the {{consolecmd|editWorld}} console command.

== Editor Issues ==

=== I can't select a brush/surface ===
You're too close! '''Try moving the camera further away''' from the object you're trying to select. Otherwise the editor will assume you're intentionally inside the object and therefore don't want to select it.

=== I can only select one object and not anything underneath it ===
Shift-clicking to select an object only lets you select the 'nearest' (or 'topmost') object, be it a brush, surface or entity. '''Use {{accelkey|Alt}}{{accelkey|Shift}}{{accelbtn|LMB}}''' to drill down through multiple objects, to the one you want to select.

=== I pressed something and everything vanished ===
You may have accidentally hidden them. Pressing {{accelkey|H}} hides the selected objects. Pressing {{accelkey|Ctrl}}{{accelkey|Shift}}{{accelkey|H}} hides all the unselected objects. '''Pressing {{accelkey|Shift}}{{accelkey|H}} brings them all back.''' If that didn't do it, try {{accelkey|Ctrl}}{{accelkey|Z}} to undo the last edit you made.

=== I can't stretch brushes anymore, only move them ===
You may have accidentally turned the 'Move selection mode (no size)' option on. '''Toggle it by pressing {{accelkey|W}}.'''

=== 'Nothing to build' ===
Usually, you can stretch brushes by dragging from one of its surfaces using the mouse. However, if the surface you're trying to move is at a strange angle, or the brush is malformed, then you are not allowed to stretch it. '''This can often be overcome by selecting the brush and using {{accelkey|Ctrl}}{{accelkey|G}} to snap its vertices to the grid.'''

=== editWorld crashes when I load big maps (or lots of small ones) ===
This is most often caused by low memory. '''Try using the 'Open Low Memory' command''' from the File menu instead and see if that works. It is advised to have at least 1GB of memory when editing large maps, and 2GB or more is preferable.

=== A brush shows up as red in vertex manipulation mode ===
This indicates that '''the brush is malformed''', and hence editWorld will only let you fix or delete it. All brushes must have sides that are completely flat, and form a convex object (i.e. there aren't any holes or dents). Usually this can be fixed by selecting the object and pressing {{accelkey|Ctrl}}{{accelkey|G}}, which will snap its vertices to the grid and tries to fix any errors. If this doesn't work, you are best off deleting the brush and creating a new one.

=== How do I compile my map? ===
From the 'Compile' menu of editWorld, select '1 - Compile'. Remember to watch the console ({{accelkey|O}}) for any warnings or errors - these will appear in yellow and red.

== Compile Issues ==

=== 'Warning: No entities in open -- no filling' ===
There aren't any entities in the map. You need at least one. Try adding an [[Entity info_player_start|info_player_start]] entity to get started.

=== 'Warning: entity reached from outside -- no filling' ===
There is an entity on the outside of the map, in the void. This is the same problem as a leak (see below.)

=== 'Warning: (entity name): Entity leaked' ===
This means either a) you have an entity outside your map, or b) you have a 'leak' in your map. When you get this error, editWorld will indicate in the 3D view which entity leaked, and the path it leaked through. If you follow the path, it should lead you to a hole in your map - which might be a missing wall or ceiling, or just a tiny gap between brushes that leads to the void outside. Any holes or gaps must be sealed. This error will occur once for each leak in your map.

Remember that entities, patches and even some special textures do not seal the level - you need to have brushwork (even just using the caulk texture) to stop entities leaking into the void. Use the leak path to work out where the leak is occurring.

== Game Issues ==

=== The game can't see my map ===
First, ensure that your map has compiled correctly and is in the correct directory - there should be a few files named {{filename|''yourmap''.world}}, {{filename|''yourmap''.entities}}, {{filename|''yourmap''.cmb}}, and {{filename|''yourmap''.procb}} in the {{filename|base/maps}} folder of ETQW.

=== {{consolecmd|devmap}} only lists campaign maps ===
Use {{consolecmd|si_rules sdGameRulesObjective}} to change the game mode. {{consolecmd|devmap}} will then show non-campaign maps.

Alternatively, you can create a new campaign file in {{filename|base\def\campaigns\}} with your map specified in it, but this should only be used if you intend to create a campaign.

=== I can't build constructibles or capture spawns ===
The game may still be in warmup mode - press {{accelkey|f3}} to confirm you're ready and the game should start after 30 seconds.

== Lighting Issues ==

=== My map is pitch-black ===
The area either lacks [[Lighting Basics|lights]], has no ambience set, or is completely in shadow. If there are no lights, try adding some. Make sure they work in editWorld in Render Mode (usually toggled with {{accelkey|F3}}).

=== My map is multi-coloured green and purple ===
This indicates that an ambience ([[Entity light_ambient|light_ambient]]) has not been specified for the area, or has been given a bad ambience to use. Check that there is exactly one [[Entity light_ambient|light_ambient]] entity in the affected area, and that it specifies an ambience ({{keyname|Ambient Cubemap}}) that is both valid and not meant to produce multicoloured lighting. Ambient Cubemaps {{keyvalue|_blank}} and {{keyvalue|_default}} produce this sort of lighting, so make sure you're not using those - try something like {{keyvalue|area22}} instead.

== Collision Issues ==
TODO

== Graphical Issues ==

=== How do I make sky ===
Texture the brushes you want to appear as sky with the '[[Common Textures#common/caulk|common/caulk]]' texture. You'll also need an '[[Entity atmosphere|atmosphere]]' entity in your level, specifying the atmosphere you wish to use.

== See Also ==
* [http://community.enemyterritory.com/forums/forumdisplay.php?f=24 QUAKE Wars Mods and Editing] for mapping issues
* [http://community.enemyterritory.com/forums/forumdisplay.php?f=28 QUAKE Wars Bugs & Tech Help] for suspected bugs

[[Category:Level Design]]

Design: How do I

2007-11-21T12:21:44Z

JRAD:

'''This is your quick reference guide for all those tasks you know are possible, but just can't quite remember how to do...'''

The commands listed below assume default key shortcuts.

== Views ==
* '''Move the 2D view''' - drag with the {{accelbtn|RMB}} in a 2D view
* '''Zoom the 2D view''' - use {{accelbtn|mouse wheel}} in a 2D view
* '''Change the grid size''' - use the {{accelkey|]}} and {{accelkey|[}} keys, numbers {{accelkey|1}} to {{accelkey|9}} on the keyboard, or the 'Grid' menu
* '''Place camera at cursor''' in 2D view - {{accelkey|ctrl}}{{accelbtn|LMB}} on new camera position
* '''Aim camera at cursor''' in 2D view - {{accelbtn|MMB}} at new camera target

== General Editing ==
* '''Create a brush''' - {{accelbtn|LMB}}-drag in a 2D view
* '''Create an entity''' - {{accelbtn|RMB}}-click in a 2D view
* '''Select an object''' - use {{accelkey|shift}}{{accelbtn|LMB}} or {{accelkey|alt}}{{accelkey|shift}}{{accelbtn|LMB}}
* '''Select several objects''' (box-selection) - {{accelkey|alt}}{{accelbtn|LMB}}-drag a box around the objects to select.
* '''Move an object''' - select it, then click {{accelbtn|LMB}} inside the object to drag around
* '''Rotate an object''' - select it, then press {{accelkey|ctrl}}{{accelkey|R}} followed by {{accelkey|ctrl}}{{accelkey|X}}, {{accelkey|ctrl}}{{accelkey|Y}} or {{accelkey|ctrl}}{{accelkey|Z}} (depending on axis)
* '''Rotate an object arbitrarily''' - select it, then press {{accelkey|R}} for rotation mode
* '''Duplicate the selected object''' - press {{accelkey|space}}
* '''Delete the selected object''' - press {{accelkey|backspace}}
* '''Deselect an object''' - use {{accelkey|shift}}{{accelbtn|LMB}}
* '''Deselect all''' - press {{accelkey|Escape}}
* '''Stretch a brush''' - select it, then {{accelbtn|LMB}}-click outside the brush to drag the nearest face
* '''Shear a brush''' - select it, then use {{accelkey|ctrl}}{{accelbtn|LMB}} outside the brush to drag the nearest face.
* '''Vertex manipulate a brush or patch''' - select it, then press {{accelkey|E}} or {{accelkey|V}}
* '''Clip/Slice a brush''' - select it, then use {{accelkey|ctrl}}{{accelbtn|RMB}} to place clipping points (up to 3), and {{accelkey|enter}}/{{accelkey|shift}}{{accelkey|enter}}/{{accelkey|ctrl}}{{accelkey|enter}} to finish
* '''Select a face''' - in the 3D view, use {{accelkey|ctrl}}{{accelkey|shift}}{{accelbtn|RMB}}
* '''Copy texture from a face''' - in the 3D view, with a target face selected, {{accelbtn|MMB}}-click on the face with the texture to copy
* '''Copy texture to a face''' - in the 3D view, with a source face selected, {{accelkey|ctrl}}{{accelbtn|MMB}}-click on the face with the texture to overwrite
* '''Shift or rotate a texture''' - select the brush(es) or face(s) to modify, and press {{accelkey|S}} for the surface inspector
* '''Edit an entity's properties''' - select the entity and press {{accelkey|N}} for the entity inspector
* '''Export selected brushes as .obj''' - press {{accelkey|ctrl}}{{accelkey|E}}
* '''Snap selected objects to grid''' - press {{accelkey|ctrl}}{{accelkey|G}}

== Map Features ==
* '''Spawn a player''' - place a player spawn entity, for example [[Entity info_team_gdf_spawn|info_team_gdf_spawn]]
* '''Spawn a vehicle''' - place a deployable entity, for example [[Entity deployable_spawn_icarus|deployable_spawn_icarus]]

== Map Technicalities ==
* '''Create a [[LOD Group]]''' - go to the ''Groups Inspector'' ({{accelkey|L}}), press the ''LOD Groups'' button and press the green plus sign.
* '''Assign objects to a LOD Group''' - select the objects, then {{accelbtn|RMB}} on the LOD Group and choose 'Add Selection''
* '''Change the fade in/out distances of a LOD Group''' - select the LOD Group, then alter its {{keyname|MinVisDist}} and {{keyname|MaxVisDist}} settings

== Map Organisation ==
* '''Hide unselected objects''' - press {{accelkey|ctrl}}{{accelkey|shift}}{{accelkey|h}}
* '''Hide selected objects''' - press {{accelkey|h}}
* '''Show hidden objects''' - press {{accelkey|shift}}{{accelkey|h}}
* '''Show/Hide Caulk''' - toggle with {{accelkey|Alt}}{{accelkey|6}}
* '''Show/Hide Clips''' - toggle with {{accelkey|Alt}}{{accelkey|7}}
* '''Show/Hide Entities''' - toggle with {{accelkey|Alt}}{{accelkey|2}}
* '''Show/Hide Patches''' - toggle with {{accelkey|ctrl}}{{accelkey|p}}
* '''Show/Hide References''' - toggle with {{accelkey|alt}}{{accelkey|r}}

== Testing ==
* '''Toggle the real-time renderer''' - press {{accelkey|F3}}
* '''Load the game window''' - press {{accelkey|F2}}
* '''Load my map''' - get the game window up, go to the console, and use the {{consolecmd|devmap}} command (e.g. {{consolecmd|devmap mymap}})

== In-game console commands ==
The console can be accessed by pressing the tilde button (above the TAB key). Also see [[Developer cheats]]
* '''Fly around''' - {{consolecmd|noclip}} toggles no clipping mode
* '''Be invincible''' - {{consolecmd|god}}
* '''Spawn a vehicle''' - {{consolecmd|spawn}}, e.g. {{consolecmd|spawn vehicle_husky}}
* '''Render portal outlines''' - {{consolecmd|r_showPortals}}
* '''Render face outline/wireframe''' - {{consolecmd|t_showTris}}
* '''Render coloured batch groups''' - {{consolecmd|r_showBatches}}
* '''Render occlusion tested objects''' - {{consolecmd|r_showOcclusions}}
* '''Test vis distances''' - {{consolecmd|r_visDistOfs}} e.g. {{consolecmd|r_visDistOfs 16384}} to be 16k units further away.

[[Category:Level Design]]

Enemy Territory: QUAKE Wars

2007-11-21T12:18:51Z

JRAD: /* Everything Else */

Welcome to the Enemy Territory: QUAKE Wars section. Here you'll find a variety of reference documentation and tutorials related to editing ETQW, along with links to the SDK. To learn more about Enemy Territory: QUAKE Wars, visit [http://www.enemyterritory.com www.enemyterritory.com].

==Software Development Kit==

The Enemy Territory: QUAKE Wars Software Development kit is currently in BETA. A list of download locations is [http://community.enemyterritory.com available here].

==Tutorials==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Basics ===
|-
|
* '''[[Taking A Screenshot]]''' - Settings and options for making a great screenshot!
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Terrain ===
|-
|
* '''[[Making a Terrain Model]]''' - Create a terrain mesh for your map.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Vehicles ===
|-
|
* '''[[Vehicle Tutorial]]''' - The whole thing! Click below for smaller segments.
** '''[[Vehicle Tutorial Part 1|Step 1]]''' - Design considerations, before you do anything else!
** '''[[Vehicle Tutorial Part 2|Step 2]]''' - Initial rough model, rig and basic script.
** '''[[Vehicle Tutorial Part 3|Step 3]]''' - More advanced rig and scripting.
** '''[[Vehicle Tutorial Part 4|Step 4]]''' - Further technical setup ideas.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models & Textures ===
|-
|
* '''[[Making A Normal Map]]''' - Using Renderbump to generate a bump-map from a high-poly model.
|-
|}
|}

==Script & Code==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Declarations ===
|-
|
* '''[[Materials]]''' - All you need to know about material declarations.
* '''[[Templates]]''' - Setting up templates to save time and effort.
* '''[[Surface Types]]''' - Available surface types for particle & sound effects.
* '''[[Skins]]''' - Easily switch textures on surfaces.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Vehicle Scripting ===
|-
|
* '''[[Vehicle Scripting: Basic_Overview|Basic Overview]]''' - Introduction to vehicle setup.
* '''[[Vehicle Scripting: Entity_Definition|Entity Definition]]''' - One definition to rule them all!
* '''[[Vehicle Scripting: Vehicle_Definition|Vehicle Definition]]''' - Introduction to the ''.vscript'' file.
* '''[[Vehicle Scripting: Positions_&_Views|Positions & Views]]''' - Configuring player positions & camera views.
* '''[[Vehicle Scripting: Components|Components]]''' - Details of various vehicle components.
* '''[[Vehicle Scripting: Weapons|Weapons]]''' - Things that go boom!
* '''[[Vehicle Scripting: IK|IK]]''' - Inverse Kinematics & you...
* '''[[Vehicle Scripting: Cockpits|Cockpits]]''' - Cockpit setup.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Entity Scripting ===
|-
|
* '''[[EntityClass:Overview|Classes]]''' - Tree of entity types.
* '''[[ScriptEvent:List|Events]]''' - List of all script events.
* '''[[Scripting:Examples|Examples]]''' - Some example walkthoughs of building up a scripted entity.
* '''[[Script:Files|Script Files]]''' - List of the script files used by the game.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== GUIs ===
|-
|
* '''[[GUIs|GUI Overview]]''' - Overview of the GUI system.
* '''[[GUIs: Event Based Scripting|Event Based Scripting]]''' - GUIs are event-based.
* '''[[GUIs: Materials|Materials]]''' - Using materials in GUIs.
* '''[[GUIs: Transitions|Transitions]]''' - Transitions.
* '''[[GUIs: Templates|Templates]]''' - Using templates in GUIs.
* '''[[GUIs: List Enumeration|List Enumeration]]''' - List enumerations.
* '''[[GUIs: Properties|Properties]]''' - Player/Global properties and more.
* '''[[GUIs: Timelines|Timelines]]''' - GUI timelines.
* '''[[GUIs: Layouts|Layouts]]''' - Window layouts.
* '''[[Reference (GUIs)|Reference]]''' - GUI reference.
|-
|}
|}

==Design==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Introduction ===
|-
|
* '''[[Design: New In ETQW|What's new in ETQW]]'''
* '''[[Design: ETQW from WET|Notes for W:ET mappers]]''' - for Wolfenstein: Enemy Territory mappers
* '''[[Design: editWorld from Radiant|Notes for Radiant users]]''' - for experienced Radiant users
* '''[[Design: editWorld from Worldcraft|Notes for Worldcraft users]]''' - for experienced Worldcraft users
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== The Basics ===
|-
|
* '''[[Design: editWorld Basics|Editor Basics]]''' - start here
* '''[[Design: Brush Basics|Brush Basics]]''' - make your map
* '''[[Design: Entity Basics|Entity Basics]]''' - populate your map
* '''[[Design: Lighting Basics|Lighting Basics]]''' - light your map
* '''[[Design: Portal Basics|Portal Basics]]''' - portalise your map
* '''[[Design: References|Reference Basics]]''' - modularise your map
* '''[[Design: Map files|Map files]]'''
----
* '''[[Design: How do I|How do I ...?]]''' - Common and useful tasks
* '''[[Design: Troubleshooting|Troubleshooting]]''' - Common problems and fixes
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Advanced Stuff ===
|-
|
* '''[[Design:List of Entities|List of Entities]]''' - Descriptions for all entities
* '''[[Design: Geometry Optimisation|Optimising Geometry]]''' - How to increase performance
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Everything Else ===
|-
|
* '''[[Design: editWorld Bugs and Fixes|Bugs and Fixes]]''' - Known and new bugs or issues
* '''[[Design: editWorld Customisation|Customising editWorld]]'''
|-
|}
|}

==Art==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models ===
|-
|
* '''[[In-Game Models]]''' - Making models for use in the engine.
* '''[[High-Poly Models]]''' - Making source models for baking normal maps.
* '''[[Renderbump]]''' - Create normal maps from high-poly geometry.
* '''[[Imposters]]''' - Sprites used for rendering complex models cheaply at a distance.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Animation ===
|-
|
* '''[[MD5 Export Process]]''' - How to export an animated MD5.
* '''[[Vehicle Setup]]''' - How to set up a vehicle.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Textures ===
|-
|
* '''[[Basic Texture Overview]]''' - Supported texture types and implementations.
* '''[[Texturesheets]]''' - Overview of what texturesheets are, and when to use them.
* '''[[The Atlas Editor]]''' - Create environment texture sheets to improve performance.
* '''[[RenderBumpFlat]]''' - Create normal-maps from high-poly geometry.
* '''[[Detail Textures]]''' - Add high-frequency detail to your textures.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Terrain Editing ===
|-
|
* '''[[Making a Terrain Model]]''' - Create a terrain mesh for your map.
* '''[[Terrain Editor|EditWorld's Terrain Editor]]''' - Set up a Surface Tree for your MegaTexture.
* '''[[MegaBuild]]''' - Render and compile your MegaTexture.
* '''[[Water Surfaces#Water Models|Water Surfaces]]''' - Create water to go with your landscape.
* '''[[STUFF System]]''' - Procedurally distribute models over your terrain mesh.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Atmospheres and Effects ===
|-
|
* '''[[Atmosphere Editor|The Atmosphere Editor]]''' - Create and edit atmospheres for your map.
* '''[[Ambient Light Editor|The Ambient Light Editor]]''' - Create and edit ambient light setups.
* '''[[Environment Maps]]''' - Used for reflection effects.
* '''[[Water Surfaces]]''' - Creating water effects.
* '''[[Effects Editor|The Effects Editor]]''' - Create and edit particle effects.
* '''[[Cheap Decals]]''' - Bulletholes and other collision decals.
|-
|}
|}

Templates

2007-11-21T12:18:24Z

JRAD: /* Templates */

=== Templates ===

'''This style of template should not be used. The preferred method is to use the parser-based $template instead.'''

Templates provide away to avoid repetitive copy and paste of declarations such as materials and sound shaders.
Templates are defined in the templates folder, in files with ".template" as an extension. A template is basically a fancy way of replacing one piece of placeholder text with another.

A sample template for a material is shown below:

template material/generic {
parameters < '''TextureParm''',
'''BumpBehavior''' = "useTemplate hasHeightMap< '''TextureParm''', 1.0 >" >
text {
'''BumpBehavior'''
diffusemap '''TextureParm'''_d
specularmap '''TextureParm'''_s
}
}

==== Keywords ====
===== template =====
First we have the keyword <i>template</i>. This lets the engine know that we're defining a new template. Next is the name of the template. Templates follow the same naming rules as other declarations in the engine.

===== parameters =====
Next we have the ''parameters'' block. This is a list of names that will be replaced when the template is evaluated. Think of them as placeholders for real information. Each name is separated by a comma (,) and can optionally have a ''default value''. The whole block is enclosed in < > to make it more readable.

Default parameters allow you to specify things that aren't often changed. As soon as you specify a default value for a parameter, all parameters following it must also have defaults. If you leave off a default parameter when one is needed you will get a warning about it in the console.

If you want to override a default parameter, but don't want to specify custom values for any preceding default parameters, give them a value of "__default" to automatically use their default value.

===== text =====
The ''text'' block contains the actual text that is inserted into your declaration. Parameters that match text exactly (that is, case matters) will be replaced by the values that are passed into the template.

==== Terminology ====
''Parameter'' - This is a named placeholder that we use to mark where we want substitute in values.

''Argument'' - This is the value that we give to the parameter.
The argument is what is actually substituted into the the text.

==== Using Templates ====
Using a template to insert text into your declarations a simple process. In this example we create a material.

material textures/jrad/templateTest {
useTemplate material/generic< "textures/sand/dry_beach_sand_footprints" >
}

When the material is loaded it will turn into this:
material textures/jrad/templateTest {
bumpmap addnormals ( '''textures/sand/dry_beach_sand_footprints'''_local.tga,
heightmap ( '''textures/sand/dry_beach_sand_footprints'''_h.tga, 1.0 ) )
diffusemap '''textures/sand/dry_beach_sand_footprints'''_d.tga
specularmap '''textures/sand/dry_beach_sand_footprints'''_s.tga
}

Ignore for the moment where the ''bumpmap'' line came from. You'll see that anywhere the first parameter "TextureParm" appeared it has been replaced by the first ( and only, in the case ) thing that we included in the useTemplate line.

All arguments should be enclosed within quotes "", even numbers. This is to ensure that the proper values are loaded into the appropriate arguments.

==== Including Other Templates ====
You might have noticed that the bumpmap line in the above shader has come from
'''BumpBehavior''' = "useTemplate hasHeightMap< '''TextureParm''', '''ScaleParm''' >"

When the template is evaluated, all of the arguments that you pass in are first applied to all of the other arguments that you pass in. Before we start replacing text in the main body of the material we evaluate '''BumpBehavior''' with the other arguments that are passed in and end up with
useTemplate hasHeightMap< '''textures/sand/dry_beach_sand_footprints''', 1.0 >

This is what is then used to replace text in the main body of the material.

Before we get any further, here is the definition of the template ''hasHeightmap''
template hasHeightmap {
parameters < '''TextureParm''', '''ScaleParm''' >
text {
bumpmap addnormals ( '''TextureParm'''_local.tga, heightmap ( '''TextureParm'''_h.tga, '''ScaleParm''' ) )
}
}

This is one of several behaviors that are available for the bumpmap stage of materials. This provides an easy way to customize the behavior of a single template in a flexible manner instead of having an excessive number of copy-pasted "almost-the-same" templates.

Templates

2007-11-21T12:13:49Z

JRAD:

=== Templates ===

This style of template should not be used. The preferred method is to use the parser-based $template instead.

Templates provide away to avoid repetitive copy and paste of declarations such as materials and sound shaders.
Templates are defined in the templates folder, in files with ".template" as an extension. A template is basically a fancy way of replacing one piece of placeholder text with another.

A sample template for a material is shown below:

template material/generic {
parameters < '''TextureParm''',
'''BumpBehavior''' = "useTemplate hasHeightMap< '''TextureParm''', 1.0 >" >
text {
'''BumpBehavior'''
diffusemap '''TextureParm'''_d
specularmap '''TextureParm'''_s
}
}

==== Keywords ====
===== template =====
First we have the keyword <i>template</i>. This lets the engine know that we're defining a new template. Next is the name of the template. Templates follow the same naming rules as other declarations in the engine.

===== parameters =====
Next we have the ''parameters'' block. This is a list of names that will be replaced when the template is evaluated. Think of them as placeholders for real information. Each name is separated by a comma (,) and can optionally have a ''default value''. The whole block is enclosed in < > to make it more readable.

Default parameters allow you to specify things that aren't often changed. As soon as you specify a default value for a parameter, all parameters following it must also have defaults. If you leave off a default parameter when one is needed you will get a warning about it in the console.

If you want to override a default parameter, but don't want to specify custom values for any preceding default parameters, give them a value of "__default" to automatically use their default value.

===== text =====
The ''text'' block contains the actual text that is inserted into your declaration. Parameters that match text exactly (that is, case matters) will be replaced by the values that are passed into the template.

==== Terminology ====
''Parameter'' - This is a named placeholder that we use to mark where we want substitute in values.

''Argument'' - This is the value that we give to the parameter.
The argument is what is actually substituted into the the text.

==== Using Templates ====
Using a template to insert text into your declarations a simple process. In this example we create a material.

material textures/jrad/templateTest {
useTemplate material/generic< "textures/sand/dry_beach_sand_footprints" >
}

When the material is loaded it will turn into this:
material textures/jrad/templateTest {
bumpmap addnormals ( '''textures/sand/dry_beach_sand_footprints'''_local.tga,
heightmap ( '''textures/sand/dry_beach_sand_footprints'''_h.tga, 1.0 ) )
diffusemap '''textures/sand/dry_beach_sand_footprints'''_d.tga
specularmap '''textures/sand/dry_beach_sand_footprints'''_s.tga
}

Ignore for the moment where the ''bumpmap'' line came from. You'll see that anywhere the first parameter "TextureParm" appeared it has been replaced by the first ( and only, in the case ) thing that we included in the useTemplate line.

All arguments should be enclosed within quotes "", even numbers. This is to ensure that the proper values are loaded into the appropriate arguments.

==== Including Other Templates ====
You might have noticed that the bumpmap line in the above shader has come from
'''BumpBehavior''' = "useTemplate hasHeightMap< '''TextureParm''', '''ScaleParm''' >"

When the template is evaluated, all of the arguments that you pass in are first applied to all of the other arguments that you pass in. Before we start replacing text in the main body of the material we evaluate '''BumpBehavior''' with the other arguments that are passed in and end up with
useTemplate hasHeightMap< '''textures/sand/dry_beach_sand_footprints''', 1.0 >

This is what is then used to replace text in the main body of the material.

Before we get any further, here is the definition of the template ''hasHeightmap''
template hasHeightmap {
parameters < '''TextureParm''', '''ScaleParm''' >
text {
bumpmap addnormals ( '''TextureParm'''_local.tga, heightmap ( '''TextureParm'''_h.tga, '''ScaleParm''' ) )
}
}

This is one of several behaviors that are available for the bumpmap stage of materials. This provides an easy way to customize the behavior of a single template in a flexible manner instead of having an excessive number of copy-pasted "almost-the-same" templates.

UserInterfaceLocal

2007-11-21T12:09:26Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UserInterfaceLocal]]

== Overview ==
This is the GUI itself, all window defs must be inside it. You may set properties, flags, cache materials, cache sounds, set atmospheres and add events directly on the GUI. GUI script functions may be called from any event or timeline by using a "gui." prefix to the function name.

'''Example:'''
gui guis/vehicles/edf_titan {
// Properties for the GUI.
properties {
float flags = immediate( flags ) | GUI_FULLSCREEN;
}
_class_icons

// Cache the titan icon material.
materials {
"icon" "guis/assets/hud/gdf/vehicles/titan"
}

_base_icon // Template: setup background material, player list, etc.
_hud_materials // Template: Cache all materials used in the HUD.
_position( 0, 2, 10 ) // Template: Setup icon for player position 0
_position( 1, 2, 24 ) // Template: Setup icon for player position 1

// Template: Draw a generic GDF missile sight.
_gdf_generic_missile_sight( "dontshowlines", "0,0,0,1", "0,0,0,1" )
}

== Properties ==
{{:UserInterfaceLocal Properties}}

== Flags ==
{{:UserInterfaceLocal Flags}}

== Functions ==
=== Evaluator Functions ===
[[UserInterfaceLocal:compare|compare]] String comparison.
[[UserInterfaceLocal:icompare|icompare]] Case insensitive string comparison.
[[UserInterfaceLocal:wcompare|wcompare]] Wide string comparison.
[[UserInterfaceLocal:iwcompare|iwcompare]] Case insensitive string comparison. Ignores color codes.
[[UserInterfaceLocal:hcompare|hcompare]] Compare handles.
[[UserInterfaceLocal:toString|toString]] Float to string conversion.
[[UserInterfaceLocal:toWString|toWString]] Float to wide string conversion.
[[UserInterfaceLocal:toFloat|toFloat]] String value converted to a float.
[[UserInterfaceLocal:localizeArgs|localizeArgs]] Localize text with additional string arguments.
[[UserInterfaceLocal:localizeHandle|localizeHandle]] Localize text given a text declaration handle.
[[UserInterfaceLocal:localize|localize]] Localize text.
[[UserInterfaceLocal:square|square]] Squares the input value.
[[UserInterfaceLocal:vec2Length|vec2Length]] Length of a 2D vector.
[[UserInterfaceLocal:vec2Normalize|vec2Normalize]] Normalize a 2D vector.
[[UserInterfaceLocal:abs|abs]] Absolute value of a float.
[[UserInterfaceLocal:min|min]] Returns the minimum of two values.
[[UserInterfaceLocal:max|max]] Returns the maximum of two values.
[[UserInterfaceLocal:clamp|clamp]] Clamp value between min and max.
[[UserInterfaceLocal:msToHMS|msToHMS]] Converts from milliseconds to hours, minutes, seconds.
[[UserInterfaceLocal:sToHMS|sToHMS]] Converts from seconds to hours, minutes, seconds.
[[UserInterfaceLocal:toggle|toggle]] Returns the opposite boolean value of the input value.
[[UserInterfaceLocal:floor|floor]] The floor of the input value.
[[UserInterfaceLocal:ceil|ceil]] The ceiling of the input value.
[[UserInterfaceLocal:toUpper|toUpper]] Convert a string to upper case.
[[UserInterfaceLocal:toLower|toLower]] Convert a string to lower case.
[[UserInterfaceLocal:toWStr|toWStr]] Convert a string to a wide string.
[[UserInterfaceLocal:toStr|toStr]] Convert a wide string to a string.
[[UserInterfaceLocal:isValidHandle|isValidHandle]] Check if handle is valid.
[[UserInterfaceLocal:floatToHandle|floatToHandle]] Convert a float to a handle.
[[UserInterfaceLocal:color|color]] Convert a string to a color.
[[UserInterfaceLocal:strLen|strLen]] Length of the string.
[[UserInterfaceLocal:wstrLen|wstrLen]] Length of the wide string.
[[UserInterfaceLocal:sin|sin]] Sine of the input value.
[[UserInterfaceLocal:cos|cos]] Cosine of the input value.
[[UserInterfaceLocal:colorForIndex|colorForIndex]] Color for the index where the index is between 0 and 31.
[[UserInterfaceLocal:stringToVec4|stringToVec4]] Convert a string to a 4D vector.
=== Utility Functions ===
[[UserInterfaceLocal:consoleCommand|consoleCommand]] Exectue a console command, append to the command buffer.
[[UserInterfaceLocal:consoleCommandImmediate|consoleCommandImmediate]] Exectue a console command, immediate execution of the command.
[[UserInterfaceLocal:playSound|playSound]] Play a sound in the current sound world.
[[UserInterfaceLocal:playGameSound|playGameSound]] Play a sound in the game sound world.
[[UserInterfaceLocal:playMusic|playMusic]] Play a sound on the music channel.
[[UserInterfaceLocal:stopMusic|stopMusic]] Stop any sound on the music channel.
[[UserInterfaceLocal:querySpeakers|querySpeakers]] Desired number of speakers.
[[UserInterfaceLocal:fadeSoundClass|fadeSoundClass]] Fade a sound class to a volume in X milliseconds.
[[UserInterfaceLocal:cacheMaterial|cacheMaterial]] Store a material to the material cache.
[[UserInterfaceLocal:activate|activate]] Activate the GUI if it is not active. Calls onActivate events for windows.
[[UserInterfaceLocal:deactivate|deactivate]] Deactivate the GUI. Calls onDeactivate events for windows.
[[UserInterfaceLocal:sendCommand|sendCommand]] Send a script command, The GUI must be attached to an entity. Script event OnNetworkMessage for the player will be called with the command data.
[[UserInterfaceLocal:sendNetworkCommand|sendNetworkCommand]] Send a script command. Script event OnNetworkMessage for the player will be called with the command data.
[[UserInterfaceLocal:postNamedEvent|postNamedEvent]] Call a named event.
[[UserInterfaceLocal:postNamedEventOn|postNamedEventOn]] Call a named event on a window.
[[UserInterfaceLocal:scriptCall|scriptCall]] Call a script event on the entity this GUI is bound to. The script parameters should be pushed.on the stack using scriptPush<type>() script calls.
[[UserInterfaceLocal:setCookieString|setCookieString]] Set a key/val which will be saved in the user profile.
[[UserInterfaceLocal:getCookieString|getCookieString]] Return value for the key.
[[UserInterfaceLocal:setCookieInt|setCookieInt]] Set an integer key/val which will be saved in the user profile.
[[UserInterfaceLocal:getCookieInt|getCookieInt]] Return integer value for the key.
[[UserInterfaceLocal:setShaderParm|setShaderParm]] Sets a shader parameter value. This is for example used while drawing the command map so different material stages can be used depending on if the command map is drawn in a circle or a rectangle
[[UserInterfaceLocal:getKeyBind|getKeyBind]] Get the key for a binding.
[[UserInterfaceLocal:print|print]] Print a string to the console. _newline or _quote should be used instead of the escape characters \n and \" respectively.
[[UserInterfaceLocal:getStringForProperty|getStringForProperty]] Get string for a window property.
[[UserInterfaceLocal:setPropertyFromString|setPropertyFromString]] Set a property from a string.
[[UserInterfaceLocal:broadcastEvent|broadcastEvent]] Broadcast a named event to a window. If no window is specified post the event on the GUI.
[[UserInterfaceLocal:broadcastEventToChildren|broadcastEventToChildren]] Broadcast an event only to immediate children.
[[UserInterfaceLocal:broadcastEventToDescendants|broadcastEventToDescendants]] Broadcast an event recursively to all children.
[[UserInterfaceLocal:getParentName|getParentName]] Get parent name.
[[UserInterfaceLocal:copyHandle|copyHandle]] Copy a handle. Should be used instead of immediate for integers.
[[UserInterfaceLocal:activateMenuSoundWorld|activateMenuSoundWorld]] Activates the menu sound world and pauses the game sound world or deactivates the menu sound world and unpauses the game sound world.
[[UserInterfaceLocal:getStringMapValue|getStringMapValue]] Get value for a key for the give string map def. Used to cache crosshair material used by the player.
[[UserInterfaceLocal:isBackgroundLoadComplete|isBackgroundLoadComplete]] Check if loading of menu models (earth/stars/strogg fleet etc.) has been loaded.
[[UserInterfaceLocal:copyText|copyText]] Copy the text to the clipboard.
[[UserInterfaceLocal:pasteText|pasteText]] Copy the clipboard data.
[[UserInterfaceLocal:uploadLevelShot|uploadLevelShot]] Upload an image to a target image. Used for map screenshots.
[[UserInterfaceLocal:getGameTag|getGameTag]] Game build name.
[[UserInterfaceLocal:getLoadTip|getLoadTip]] Get a load tooltip intended for the map loading screen.
[[UserInterfaceLocal:cancelToolTip|cancelToolTip]] Set float property active to false for the toolTip window.
[[UserInterfaceLocal:checkCVarsAgainstCFG|checkCVarsAgainstCFG]] Used in game options to check the machine spec the user has chosen.
[[UserInterfaceLocal:collapseColors|collapseColors]] Collapse all color codes.
=== Game Functions ===
[[UserInterfaceLocal:getSpectatorList|getSpectatorList]] List of spectators separated with commas. Used with the marquee window type for scrolling.
[[UserInterfaceLocal:getTeamPlayerCount|getTeamPlayerCount]] Get the number of players on a team.
[[UserInterfaceLocal:getWeaponData|getWeaponData]] Get weapon value given a key. Mainly used for getting model and model/joint names for player in the limbo menu.
[[UserInterfaceLocal:getNumWeaponPackages|getNumWeaponPackages]] Get number of weapon packages for a class.
[[UserInterfaceLocal:getWeaponBankForName|getWeaponBankForName]] Get bank number for slot name.
[[UserInterfaceLocal:updateLimboProficiency|updateLimboProficiency]] Set new player class and update the proficiency related limbo properties. Used for updating limbo properties when selecting a class.
[[UserInterfaceLocal:getRoleCountForTeam|getRoleCountForTeam]] Number of players with a specific role on a team.
[[UserInterfaceLocal:getEquivalentClass|getEquivalentClass]] Get the equivalent class on the target team to the class on the current team.
[[UserInterfaceLocal:getClassSkin|getClassSkin]] Get skin name for class.
[[UserInterfaceLocal:toggleReady|toggleReady]] Toggle the local player to be ready during warmup.
[[UserInterfaceLocal:execVote|execVote]] Execute a vote on client or listen server. The vote index then the vote key should have been pushed on the GUI stack before calling this function.
[[UserInterfaceLocal:getCommandMapTitle|getCommandMapTitle]] Get the command map title for a playzone on the current map.
[[UserInterfaceLocal:getPersistentRankInfo|getPersistentRankInfo]] Get the current rank or rank material name for the local player.
[[UserInterfaceLocal:setSpawnPoint|setSpawnPoint]] Set the current spawn point for the local player. Send the name to the server if a client.
[[UserInterfaceLocal:highlightSpawnPoint|highlightSpawnPoint]] Call script event OnHighlight on the spawnpoint for the team.
[[UserInterfaceLocal:mutePlayer|mutePlayer]] Toggle mute for a player.
[[UserInterfaceLocal:spectateClient|spectateClient]] Spectate a specific client, works on client and listen server.
[[UserInterfaceLocal:chatCommand|chatCommand]] Send a chat command.
=== CVar Functions ===
[[UserInterfaceLocal:setCVar|setCVar]] Set a cvar.
[[UserInterfaceLocal:getCVar|getCVar]] Get a cvar value.
[[UserInterfaceLocal:resetCVar|resetCVar]] Reset a CVar, gives it the default value.
[[UserInterfaceLocal:setCVarFloat|setCVarFloat]] Set a cvar.
[[UserInterfaceLocal:getCVarFloat|getCVarFloat]] Get a cvar value.
[[UserInterfaceLocal:setCVarInt|setCVarInt]] Set a cvar.
[[UserInterfaceLocal:getCVarInt|getCVarInt]] Get a cvar value.
[[UserInterfaceLocal:setCVarBool|setCVarBool]] Set a cvar.
[[UserInterfaceLocal:getCVarBool|getCVarBool]] Get a cvar value.
[[UserInterfaceLocal:getCVarColor|getCVarColor]] Get a cvar value.
[[UserInterfaceLocal:isCVarLocked|isCVarLocked]] Check if a CVar has the CVAR_GUILOCKED flag set.
=== Stack Functions ===
[[UserInterfaceLocal:scriptPushString|scriptPushString]] Push a string on the stack.
[[UserInterfaceLocal:scriptPushFloat|scriptPushFloat]] Push a float on the stack.
[[UserInterfaceLocal:scriptPushVec2|scriptPushVec2]] Push a vec2 on the stack.
[[UserInterfaceLocal:scriptPushVec3|scriptPushVec3]] Push a vec3 on the stack.
[[UserInterfaceLocal:scriptPushVec4|scriptPushVec4]] Push a vec4 on the stack.
[[UserInterfaceLocal:scriptGetWStringResult|scriptGetWStringResult]] Pop a wide string from the stack.
[[UserInterfaceLocal:scriptGetStringResult|scriptGetStringResult]] Pop a string from the stack.
[[UserInterfaceLocal:scriptGetFloatResult|scriptGetFloatResult]] Pop a float from the stack.
[[UserInterfaceLocal:scriptGetVec2Result|scriptGetVec2Result]] Pop a vec2 from the stack.
[[UserInterfaceLocal:scriptGetVec4Result|scriptGetVec4Result]] Pop a vec4 from the stack.
[[UserInterfaceLocal:pushGeneralString|pushGeneralString]] Push a string on the stack with the given name. Any literal stack name is valid.
[[UserInterfaceLocal:popGeneralString|popGeneralString]] Pop a string on the stack with the given name. Any literal stack name is valid.
[[UserInterfaceLocal:getGeneralString|getGeneralString]] Get the string on the top of the stack with the given name, does not pop the stack. Any literal stack name is valid.
[[UserInterfaceLocal:generalStringAvailable|generalStringAvailable]] Check if a stack with the given name is available.
[[UserInterfaceLocal:clearGeneralStrings|clearGeneralStrings]] Clear the stack with the given name.

== Events ==
[[UserInterfaceLocal:onCreate|onCreate]] Called on window creation
[[UserInterfaceLocal:onActivate|onActivate]] This happens when the GUI is activated.
[[UserInterfaceLocal:onDeactivate|onDeactivate]] This happens when the GUI is activated.
[[UserInterfaceLocal:onNamedEvent|onNamedEvent]] Called when one of the events specified occurs
[[UserInterfaceLocal:onPropertyChanged|onPropertyChanged]] Called when one of the properties specified occurs
[[UserInterfaceLocal:onCVarChanged|onCVarChanged]] Called when one of the CVars' value changes
[[UserInterfaceLocal:onCancel|onCancel]] Called when any key bound to the _menuCancel is pressed

[[Category:GUIs]]

UIRenderCamera Animated

2007-11-21T12:09:15Z

JRAD:

== Class Tree ==
* [[:UIObject]]
** [[:UIRenderWorld_Child]]
*** [[:UIRenderCamera_Animated]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIRenderWorld_Child]].

Window type:
type renderCameraAnim;

== Properties ==
{{:UIRenderCamera_Animated Properties}}

== Flags ==
{{:UIRenderCamera_Animated Flags}}

== Functions ==

== Events ==

[[Category:GUIs]]

UIRenderCamera

2007-11-21T12:09:06Z

JRAD:

== Class Tree ==
* [[:UIObject]]
** [[:UIRenderWorld_Child]]
*** [[:UIRenderCamera]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIRenderWorld_Child]].

Window type:
type renderCamera;

== Properties ==
{{:UIRenderCamera Properties}}

== Flags ==
{{:UIRenderCamera Flags}}

== Functions ==

== Events ==

[[Category:GUIs]]

UIRenderLight

2007-11-21T12:08:56Z

JRAD:

== Class Tree ==
* [[:UIObject]]
** [[:UIRenderWorld_Child]]
*** [[:UIRenderLight]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIRenderWorld_Child]].

Window type:
type renderLight;

== Properties ==
{{:UIRenderLight Properties}}

== Flags ==
{{:UIRenderLight Flags}}

== Functions ==

== Events ==

[[Category:GUIs]]

UIRenderModel

2007-11-21T12:08:46Z

JRAD:

== Class Tree ==
* [[:UIObject]]
** [[:UIRenderWorld_Child]]
*** [[:UIRenderModel]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIRenderWorld_Child]].

Window type:
type renderModel;

== Properties ==
{{:UIRenderModel Properties}}

== Flags ==
{{:UIRenderModel Flags}}

== Functions ==

== Events ==

[[Category:GUIs]]

UIRenderWorld Child

2007-11-21T12:08:36Z

JRAD:

== Class Tree ==
* [[:UIObject]]
** [[:UIRenderWorld_Child]]

== Overview ==
This class is abstract and may not be used directly in the GUIs. Any classes deriving from this class will inherit all its properties, flags, functions and events. It will inherit all properties, flags, functions and events from [[UIObject]]

== Properties ==
{{:UIRenderWorld_Child Properties}}

== Flags ==
{{:UIRenderWorld_Child Flags}}

== Functions ==

== Events ==

[[Category:GUIs]]

UISlider

2007-11-21T12:08:25Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UISlider]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type slider;

== Properties ==
{{:UISlider Properties}}

== Flags ==
{{:UISlider Flags}}

== Functions ==

== Events ==
[[UISlider:onMouseEnterThumb|onMouseEnterThumb]] Called when the mouse enters the thumb.
[[UISlider:onMouseExitThumb|onMouseExitThumb]] Called when the mouse exits the thumb.
[[UISlider:onMouseEnterUpArrow|onMouseEnterUpArrow]] Called when the mouse enters the up arrow.
[[UISlider:onMouseExitUpArrow|onMouseExitUpArrow]] Called when the mouse exits the up arrow.
[[UISlider:onMouseEnterDownArrow|onMouseEnterDownArrow]] Called when the mouse enters the down arrow.
[[UISlider:onMouseExitDownArrow|onMouseExitDownArrow]] Called when the mouse exits the down arrow.
[[UISlider:onMouseEnterGutter|onMouseEnterGutter]] Called when the mouse enters the gutter.
[[UISlider:onMouseExitGutter|onMouseExitGutter]] Called when the mouse exits the gutter.
[[UISlider:onMouseDownUpArrow|onMouseDownUpArrow]] Called when the left mouse button is pressed on the up arrow.
[[UISlider:onMouseUpUpArrow|onMouseUpUpArrow]] Called when the left mouse button is depressed on the up arrow.
[[UISlider:onMouseDownDownArrow|onMouseDownDownArrow]] Called when the left mouse button is pressed on the down arrow.
[[UISlider:onMouseUpDownArrow|onMouseUpDownArrow]] Called when the left mouse button is depressed on the down arrow.
[[UISlider:onMouseDownThumb|onMouseDownThumb]] Called when the left mouse button is pressed on the thumb.
[[UISlider:onMouseUpThumb|onMouseUpThumb]] Called when the left mouse button is depressed on the thumb.
[[UISlider:onMouseDownGutter|onMouseDownGutter]] Called when the left mouse button is pressed in the gutter.
[[UISlider:onMouseUpGutter|onMouseUpGutter]] Called when the left mouse button is depressed in the gutter.
[[UISlider:onBeginScroll|onBeginScroll]] Called when starting to drag the thumb.
[[UISlider:onEndScroll|onEndScroll]] Called when stopped dragging the thumb.

[[Category:GUIs]]

UIRenderWorld

2007-11-21T12:08:15Z

JRAD:

== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIRenderWorld]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type renderWorld;

== Properties ==
{{:UIRenderWorld Properties}}

== Flags ==
{{:UIRenderWorld Flags}}

== Functions ==

== Events ==

[[Category:GUIs]]

UIRadialMenu

2007-11-21T12:08:05Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIRadialMenu]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type radialmenu;

== Properties ==
{{:UIRadialMenu Properties}}

== Flags ==
{{:UIRadialMenu Flags}}

== Functions ==
=== General Functions ===
[[UIRadialMenu:insertItem|insertItem]] Insert an item into a page.
[[UIRadialMenu:insertPage|insertPage]] Insert a new page.
[[UIRadialMenu:getItemData|getItemData]] Get item data.
[[UIRadialMenu:clear|clear]] Clear all pages.
[[UIRadialMenu:clearPage|clearPage]] Clear all page items.
[[UIRadialMenu:pushPage|pushPage]] Push page on stack, make it the current page and reset mouse position. Calls onPagePushed event.
[[UIRadialMenu:popPage|popPage]] Pop the stack of pages. Current page is the page on the top after popping.
[[UIRadialMenu:clearPageStack|clearPageStack]] Clear the page stack.
[[UIRadialMenu:postCommand|postCommand]] Post a command with the command data for the item.
[[UIRadialMenu:loadFromDef|loadFromDef]] Load a radial menu from def files.
[[UIRadialMenu:appendFromDef|appendFromDef]] Load a radial menu page from def files.
[[UIRadialMenu:fillFromEnumerator|fillFromEnumerator]] Fill menu from an enumerator.
[[UIRadialMenu:transitionItemVec4|transitionItemVec4]] Transition for an item.
[[UIRadialMenu:getItemTransitionVec4Result|getItemTransitionVec4Result]] Get the result from a transition given a property type.
[[UIRadialMenu:clearTransitions|clearTransitions]] Clear transitions.

== Events ==
[[UIRadialMenu:onCommand|onCommand]] Called when the given input command occurs. The game script calls these commands to control navigation within the quick chat.
[[UIRadialMenu:onMeasureItem|onMeasureItem]] Measure the item size before drawing.
[[UIRadialMenu:onDrawItem|onDrawItem]] Draw a quick chat item.
[[UIRadialMenu:onDrawContext|onDrawContext]] Draw the context button (centered in the radial menu).
[[UIRadialMenu:onDrawDeadZone|onDrawDeadZone]] Not used.
[[UIRadialMenu:onPagePushed|onPagePushed]] Called when the player enters a new page.
[[UIRadialMenu:onPagePopped|onPagePopped]] Called when the player exits a page. currentPage will be -1 if there is no valid page.

[[Category:GUIs]]

UIProgress

2007-11-21T12:07:54Z

JRAD:

== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIProgress]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type progress;

== Properties ==
{{:UIProgress Properties}}

== Flags ==
{{:UIProgress Flags}}

== Functions ==

== Events ==

[[Category:GUIs]]

Reference (GUIs)

2007-11-21T12:07:40Z

JRAD: /* Window Types */

UIMarquee

2007-11-21T12:07:25Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIMarquee]]

== Overview ==
Marquee window type is used for scrolling text vertically or horizontally. It is used for showing the message of the day in the main menu and the spectator list in the scoreboard and limbo menu.

This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type marquee;

'''Example:'''
windowDef spectatorList {
type marquee;
properties {
rect rect = PADDING, _to_bottom_of( lblSpectating ) + 2, _fill_to_right_of( specInfoSurround ), 14;
float fontSize = 12;
color forecolor = 1,1,1,0.7;
vec2 textAlignment = TA_LEFT, TA_VCENTER;
float speed = 9;
}

timeline {
onTime 500 {
text = toWStr( gui.getSpectatorList() );
resetTime( 0 );
}
}
}

== Properties ==
{{:UIMarquee Properties}}

== Flags ==
{{:UIMarquee Flags}}

== Functions ==
=== General Functions ===
[[UIMarquee:resetScroll|resetScroll]] Reset scroll amount.

== Events ==

[[Category:GUIs]]

UIList

2007-11-21T12:07:13Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIList]]

== Overview ==
The list window type can be used if you want display a list in the GUI. It is the most complex window type in the GUI system. Some of the features of the list type are column headers, drawing of text or materials in headers and items, saving additional data in items, column sorting, variable row height, filling from enumerators, mouse and key events on header columns and items.

This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type list;

'''Example:'''
windowDef vPlayerList {
type list;
properties {
float fontSize = 48;
// Truncate player name to the item rectangle
float flags = immediate( flags ) | WF_TRUNCATE_TEXT;
rect rect = 24, 50, 590, 350;
color backColor = 0,0,0,0;
}
events {
onCreate {
insertColumn( gui.blankWStr, 0, 0 ); // Class icon column.
insertColumn( gui.blankWStr, 590, 1 ) // Player name column;
}
}
timeLine {
onTime 250 {
// Have the gamecode update the list of players in the vehicle every 250 milliseconds.
fillFromEnumerator( "vehiclePlayerList" );
resetTime( 0 );
}
}
}

== Properties ==
{{:UIList Properties}}

== Flags ==
{{:UIList Flags}}

== Functions ==
=== General Functions ===
[[UIList:insertItem|insertItem]] Insert list item. Calls onItemAdded event.
[[UIList:insertBlankItems|insertBlankItems]] Insert multiple blank items.
[[UIList:setItemText|setItemText]] Set item text.
[[UIList:setItemTextFlags|setItemTextFlags]] Set item text flags.
[[UIList:setItemForeColor|setItemForeColor]] Set item forecolor.
[[UIList:setItemBackColor|setItemBackColor]] Set item backcolor.
[[UIList:setItemMaterialSize|setItemMaterialSize]] Set iteam material size.
[[UIList:setItemIcon|setItemIcon]] Set icon for item.
[[UIList:transitionItemVec4|transitionItemVec4]] Transition a property for an item.
[[UIList:getItemTransitionVec4Result|getItemTransitionVec4Result]] Get the items immediate transition value.
[[UIList:transitionColumnVec4|transitionColumnVec4]] Transition a property for a column.
[[UIList:getColumnTransitionVec4Result|getColumnTransitionVec4Result]] Get the columns immediate transition value.
[[UIList:clearTransitions|clearTransitions]] Clear transitions for an item.
[[UIList:setColumnText|setColumnText]] Set column header text.
[[UIList:setColumnWidth|setColumnWidth]] Set column width.
[[UIList:setColumnTextFlags|setColumnTextFlags]] Set column header text flags.
[[UIList:deleteItem|deleteItem]] Delete an item from the list. Calls onItemRemoved event.
[[UIList:insertColumn|insertColumn]] Insert a column.
[[UIList:deleteColumn|deleteColumn]] Delete a column. NOT IMPLEMENTED.
[[UIList:clearItems|clearItems]] Delete all items.
[[UIList:clearColumns|clearColumns]] Delete all columns.
[[UIList:getItemText|getItemText]] Get item text. Returns header text if row is -1.
[[UIList:getItemRect|getItemRect]] Get item rectangle.
[[UIList:fillFromEnumerator|fillFromEnumerator]] Fill list using the specified enumerator.
[[UIList:sort|sort]] Explicitly sort list.
[[UIList:getItemAtPoint|getItemAtPoint]] Get item at position. Often used to get the list item under the cursor.
[[UIList:findItem|findItem]] Finds first item in column which matches the search text.
[[UIList:findItemDataInt|findItemDataInt]] Find the item with the item data.
[[UIList:setItemDataInt|setItemDataInt]] Set item data.
[[UIList:getItemDataInt|getItemDataInt]] Get item data.
[[UIList:storeVisualState|storeVisualState]] Store the visual state, in essence the scroll amount.
[[UIList:restoreVisualState|restoreVisualState]] Restore the visual state. Makes the layout dirty.
[[UIList:drawItemMaterial|drawItemMaterial]] Draw a material in the given item.
[[UIList:sizeLastColumn|sizeLastColumn]] Stretch the last column to fill any leftover space, minus the amount passed in.
[[UIList:setItemFlags|setItemFlags]] Set item flags.
[[UIList:setColumnFlags|setColumnFlags]] Set column header flags.
[[UIList:ensureItemIsVisible|ensureItemIsVisible]] Potentially scroll the list to make sure the item is visible.
[[UIList:fillFromFile|fillFromFile]] Fill list from file. Supports UTF8 encoding.

== Events ==
[[UIList:onSelectItem|onSelectItem]] Called when a list item is selected.
[[UIList:onItemAdded|onItemAdded]] Called when an item is inserted into the list.
[[UIList:onItemRemoved|onItemRemoved]] Called when an item is deleted from the list.
[[UIList:onDrawSelectedBackground|onDrawSelectedBackground]] If this event is valid in the GUI it will be called instead of onDrawItemBackGround for the currently selected item.
[[UIList:onDrawItemBackGround|onDrawItemBackGround]] Called when drawing an item background.
[[UIList:onDrawItem|onDrawItem]] Called when drawing an item.
[[UIList:onDrawColumn|onDrawColumn]] Called when drawing a column.
[[UIList:onEnterColumnHeader|onEnterColumnHeader]] Called when the mouse enters a column header.
[[UIList:onExitColumnHeader|onExitColumnHeader]] Called when the mouse exits a column header.
[[UIList:onClickColumnHeader|onClickColumnHeader]] Called when there's a mouse click on the column header.
[[UIList:onEnterItem|onEnterItem]] Called when the mouse enters the list item.
[[UIList:onExitItem|onExitItem]] Called when the mouse exits the list item.

[[Category:GUIs]]

UIIconNotification

2007-11-21T12:07:03Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIIconNotification]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type iconNotification;

== Properties ==
{{:UIIconNotification Properties}}

== Flags ==
{{:UIIconNotification Flags}}

== Functions ==
=== General Functions ===
[[UIIconNotification:addIcon|addIcon]] Add an icon to the list of notify icons.
[[UIIconNotification:removeIcon|removeIcon]] Remove an icon from the list of notify icons.
[[UIIconNotification:clear|clear]] Clear all notification icons.
[[UIIconNotification:getFirstItem|getFirstItem]] Get the first notification icon.
[[UIIconNotification:bumpIcon|bumpIcon]] Bump a notify icon.
[[UIIconNotification:fillFromEnumerator|fillFromEnumerator]] Fill list of notify icons from an enumerator.
[[UIIconNotification:setItemData|setItemData]] Set item data.
[[UIIconNotification:getItemData|getItemData]] Get item data.
[[UIIconNotification:getItemText|getItemText]] Get item text.
[[UIIconNotification:setItemText|setItemText]] Set item text.
[[UIIconNotification:getItemAtPoint|getItemAtPoint]] Get item at position. Often used to get the list item under the cursor.

== Events ==
[[UIIconNotification:onIconAdded|onIconAdded]] Called when an item has been added.
[[UIIconNotification:onIconRemoved|onIconRemoved]] Called when an item has been removed.
[[UIIconNotification:onPreDrawIcon|onPreDrawIcon]] Called before drawing an icon with the item handle specified.

[[Category:GUIs]]

UIEditW

2007-11-21T12:06:52Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIEditW]]

== Overview ==
The wide edit window type has the same functionality as the regular edit window, but it supports wide strings for non ASCII input. It is mainly used when typing messages to friends or in the chat window.

Templates are used to decrease the amount of text needed to create an edit box, the _editw/_editw_scroll and _end_edit/_end_editw_scroll templates should be used.

This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type editw;

'''Example:'''
_editw_scroll( MessageMemberMessage, 0, 0, 100, 60 )
properties {
vec2 textAlignment = TA_LEFT, TA_VCENTER;
float maxTextLength = 512;
}
_end_editw_scroll

== Properties ==
{{:UIEditW Properties}}

== Flags ==
{{:UIEditW Flags}}

== Functions ==
=== General Functions ===
[[UIEditW:clearText|clearText]] Clear all window text.
[[UIEditW:isWhitespace|isWhitespace]] Check whitespaces, ignores all color codes.
[[UIEditW:insertText|insertText]] Insert text into the edit box.
[[UIEditW:surroundSelection|surroundSelection]] Select certain substring.
[[UIEditW:anySelected|anySelected]] Check if any of the edit text is selected.
[[UIEditW:selectAll|selectAll]] Select all text in the edit box.

== Events ==
[[UIEditW:onInputFailed|onInputFailed]] Called if typing any characters that breaks the EF_ALLOW_DECIMAL/EF_INTEGERS_ONLY flags.

[[Category:GUIs]]

UIEdit

2007-11-21T12:06:29Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIEdit]]

== Overview ==
An edit window should be used to get text input from the player. It is used for entering a server password, player name, clan tag, renaming the fireteam and chat text among other things. If the edit window should support non ASCII characters then editw should be used instead.

Templates are used to decrease the amount of text needed to create an edit box, the _edit and _end_edit templates should be used.

This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type edit;

'''Example:'''
_edit( createServerName, 100, 0, 100, BUTTON_HEIGHT )
_cvar_set_edit( si_name )
_draw_left_edit_label( localize( "guis/mainmenu/servername" ), COLOR_TEXT, 100 )
properties {
float maxTextLength = 30;
}
_end_edit

== Properties ==
{{:UIEdit Properties}}

== Flags ==
{{:UIEdit Flags}}

== Functions ==
=== General Functions ===
[[UIEdit:clearText|clearText]] Clear all window text.
[[UIEdit:isWhitespace|isWhitespace]] Check whitespaces, ignores all color codes.
[[UIEdit:insertText|insertText]] Insert text into the edit box.
[[UIEdit:surroundSelection|surroundSelection]] Select certain substring.
[[UIEdit:anySelected|anySelected]] Check if any of the edit text is selected.
[[UIEdit:selectAll|selectAll]] Select all text in the edit box.

== Events ==
[[UIEdit:onInputFailed|onInputFailed]] Called if typing any characters that breaks the EF_ALLOW_DECIMAL/EF_INTEGERS_ONLY flags.

[[Category:GUIs]]

UICreditScroll

2007-11-21T12:06:18Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UICreditScroll]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type creditScroll;

== Properties ==
{{:UICreditScroll Properties}}

== Flags ==
{{:UICreditScroll Flags}}

== Functions ==
=== General Functions ===
[[UICreditScroll:resetScroll|resetScroll]] Reset scroll amount.
[[UICreditScroll:loadFromFile|loadFromFile]] Load the text to scroll from a file. Supports UTF8.

== Events ==

[[Category:GUIs]]

UICinematic

2007-11-21T12:06:08Z

JRAD:

== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UICinematic]]

== Overview ==
This class is abstract and may not be used directly in the GUIs. Any classes deriving from this class will inherit all its properties, flags, functions and events. It will inherit all properties, flags, functions and events from [[UIWindow]]

== Properties ==
{{:UICinematic Properties}}

== Flags ==
{{:UICinematic Flags}}

== Functions ==

== Events ==

[[Category:GUIs]]

UIBinder

2007-11-21T12:05:50Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIBinder]]

== Overview ==
This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type binder;

== Properties ==
{{:UIBinder Properties}}

== Flags ==
{{:UIBinder Flags}}

== Functions ==
=== General Functions ===
[[UIBinder:applyBinding|applyBinding]] Apply the current key registered with the binder window.
[[UIBinder:unbindBinding|unbindBinding]] Unbind all keys bound to the bind command.

== Events ==
[[UIBinder:onBindComplete|onBindComplete]] When a new key was bound to the bind command.

[[Category:GUIs]]

UIWindow

2007-11-21T12:05:35Z

JRAD:

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]

== Overview ==
The most common window type can be used to draw text or materials within its rectangle.

In many places it is also used just for managing other windows, handling events and timelines.

This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIObject_Drawable]].

Window type:
type window;

'''Example:'''
// Define properties required to display the warmup text at the center of the screen.
windowDef warmupLabel {
_big_text_props // Template: Sets the font size.
properties {
rect rect = 0, CENTER_Y - 28, SCREEN_WIDTH, 16;
wstring text = player.matchStatus; // The text we're displaying
float visible = gui.respawnLabel.visible == false && player.warmup && player.commandmapstate == 0 && player.commandmapstate == 0 && player.scoreboardActive == false && globals.gameHud.hideCrosshairCounter == 0;
float flags = immediate( flags ) | WF_DROPSHADOW;
}
}

== Properties ==
{{:UIWindow Properties}}

== Flags ==
{{:UIWindow Flags}}

== Functions ==
=== General Functions ===
[[UIWindow:attachRenderCallback|attachRenderCallback]] Attach a render callback to the drawing of the window.
[[UIWindow:attachInputHandler|attachInputHandler]] Attach an input handler for the window.
[[UIWindow:drawMaterial|drawMaterial]] Draw a material.
[[UIWindow:drawRenderCallback|drawRenderCallback]] Call the draw render callback for the given render callback handle.
[[UIWindow:drawCachedMaterial|drawCachedMaterial]] Draw cached material.
[[UIWindow:getCachedMaterialDimensions|getCachedMaterialDimensions]] Get the width and height of the material.
[[UIWindow:drawMaterialInfo|drawMaterialInfo]] Draw material. Get data from the material info.
[[UIWindow:drawMaterialArc|drawMaterialArc]] Draw an arc.
[[UIWindow:drawTimer|drawTimer]] Draw a timer, used by the grenade indicator and progress indicators by the crosshair.
[[UIWindow:drawText|drawText]] Draw text.
[[UIWindow:measureText|measureText]] Measure the text.
[[UIWindow:measureLocalizedText|measureLocalizedText]] Measure the text.
[[UIWindow:drawTiledMaterial|drawTiledMaterial]] Draw a tiled material.
[[UIWindow:drawLocalizedText|drawLocalizedText]] Text to be drawn.
[[UIWindow:drawLine|drawLine]] Draw a line.
[[UIWindow:requestLayout|requestLayout]] Request the window layout to be calculated again.
[[UIWindow:drawRect|drawRect]] Draw a rectangle.
[[UIWindow:nextTabStop|nextTabStop]] Get the next tab stop for the specified window.
[[UIWindow:prevTabStop|prevTabStop]] Get the previous tab stop for the specified window.
[[UIWindow:setTabStop|setTabStop]] Focuses the nth tab stop.
[[UIWindow:containsPoint|containsPoint]] Checks if the (world-based) point is in the client rectangle.
[[UIWindow:cacheRenderCallback|cacheRenderCallback]] Return a reference to a render callback.
[[UIWindow:clipToRect|clipToRect]] Clip subsequent drawing to the clipping rectangle. Must be ended with unclipRect after clipped drawing is finished.
[[UIWindow:unclipRect|unclipRect]] Remove clipping to rectangle specified in clipToRect.
[[UIWindow:pushColor|pushColor]] Push a color on the GUI's color stack.
[[UIWindow:pushColorComponents|pushColorComponents]] Push a color on the GUI's color stack.
[[UIWindow:popColor|popColor]] Pop a color from the GUI's color stack.
[[UIWindow:drawShaderParm|drawShaderParm]] Set a shader parm value.
[[UIWindow:isVisible|isVisible]] Check if self is visible.

== Events ==
[[UIWindow:onPreDraw|onPreDraw]] Called before the window is about to draw. The event is often used for doing custom text and material drawing instead of the default drawing.
[[UIWindow:onPostDraw|onPostDraw]] Called after gamecode has finished drawing.
[[UIWindow:onPostChildDraw|onPostChildDraw]] Called after all descendants have finished drawing.
[[UIWindow:onMouseMove|onMouseMove]] Called when the mouse moves.
[[UIWindow:onMouseEnter|onMouseEnter]] Called when the mouse enters the window.
[[UIWindow:onMouseExit|onMouseExit]] Called when the mouse exits the window.
[[UIWindow:onKeyUp|onKeyUp]] Called when a key is depressed.
[[UIWindow:onKeyDown|onKeyDown]] Called when a key is pressed.
[[UIWindow:onKeyUpBind|onKeyUpBind]] Called when keys using the bind is depressed.
[[UIWindow:onKeyDownBind|onKeyDownBind]] Called when keys usng the bind is pressed
[[UIWindow:onShow|onShow]] When the visible property is changed to true.
[[UIWindow:onHide|onHide]] When The hide property is changed to false.
[[UIWindow:onGainFocus|onGainFocus]] The window has gained focus.
[[UIWindow:onLoseFocus|onLoseFocus]] The window has lost focus
[[UIWindow:onDoubleClick|onDoubleClick]] Mouse is double clicked within the window's rectangle.
[[UIWindow:onActivate|onActivate]] This happens when the GUI is activated.
[[UIWindow:onQueryToolTip|onQueryToolTip]] Used to set a tooltip which will be shown when the mouse os hovering over the window.
[[UIWindow:onNavForward|onNavForward]] Called when any key bound to the _menuNavForward is pressed
[[UIWindow:onNavBackward|onNavBackward]] Called when any key bound to the _menuNavBackward is pressed
[[UIWindow:onAccept|onAccept]] Called when any key bound to the _menuAccept is pressed
[[UIWindow:onCancel|onCancel]] Called when any key bound to the _menuCancel is pressed

[[Category:GUIs]]