User Manual

Table of Contents

User Tools

Site Tools

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
mapping:cawe:reference:entityguide [2006-08-13 06:10]
stephen added definitions from intro to editing 		mapping:cawe:reference:entityguide [2013-01-07 12:07] (current)
Line 1: Line 1:
 ====== Entity Guide ====== ====== Entity Guide ======
-An entity is an object that has characteristics which are different to the normal world brushes. There are two kinds of entities in Ca3DE. These include ​solid-based entities and point-based entities.+An entity is an object that has characteristics which are different to the normal world brushes. There are two kinds of entities in Cafu. These include ​brush-based entities and point-based entities.
  
-  * **Point-based entities** exist at a specific coordinate in space and be can be thought of as a reference point. Although these entities may refer to objects that actually have a volume, for example a monster, they are only treated as points in CaWE, and the Ca3D-Engine ​provides the volume later in the game. An example is a monster entity: In CaWE, it just represents the point where the monster will be, in Ca3DE, it will acutally ​be there.+  * **Point-based entities** exist at a specific coordinate in space and be can be thought of as a reference point. Although these entities may refer to objects that actually have a volume, for example a monster, they are only treated as points in CaWE, and the Cafu engine ​provides the volume later in the game. An example is a monster entity: In CaWE, it just represents the point where the monster will be, in Cafu, it will actually ​be there.
   * **Brush-based entities** are related to at least one brush or bezier patch and thus have a volume. Examples for brush based entities include doors and platforms, bodies of water, area triggers, etc.   * **Brush-based entities** are related to at least one brush or bezier patch and thus have a volume. Examples for brush based entities include doors and platforms, bodies of water, area triggers, etc.
  
-===== Placing Point Entities ===== +===== Brush-Based Entities ===== 
-1. Select the Entity tool.\\ +Solid entities are world brushes that have extra characteristics. Note: This list is not fully complete.
-{{:​mapping:​cawe:​reference:​tool.png|Entity Tool}}\\ +
-\\ +
-2. In one of the 2D windows, click where you want to place your entity. A green box will appear where you clicked. This is where the entity will be inserted.\\ +
-{{:​mapping:​cawe:​reference:​green_box.png|Green Box}}\\ +
-\\ +
-3. Drag the green box to where you want the entity in the other views.\\ +
-\\ +
-4. Select the type of entity you want to insert from the "New (point) Entity"​ dropdown box. I'm inserting an info_player_start.\\ +
-{{:​mapping:​cawe:​reference:​dropdown.png|Info_player_start}}\\ +
-\\ +
-5. Put your mouse cursor over one of the 2D views, and press enter. The entity should appear. You should be able to see it in both the 2D and 3D views.\\ +
-{{:​mapping:​cawe:​reference:​finished_point.png|Done!}}\\ +
-//Note that other entities are different colours, shapes and sizes.// +
- +
-===== Placing Solid Entities ===== +
-In this example, I will be adding water to a very simple map. The process is very similar when inserting other brush entities. +
- +
-1. Select the "​New ​Brush" tool.\\ +
-{{:​mapping:​cawe:​reference:​w_newbrush.png|NewBrush Tool}} +
- +
-2. In a 2D view, drag out a box the size you want your water to be. Adjust the size in the other 2D views. +
- +
- +
-3. //(This step is not necessary for most other entities)// Click the "​Browse"​ button in the texture settings (under the tool icons). When the viewer pops up, change the filter to "​water"​ (without quotes). Select ​ one of the materials.\\ +
-{{:​mapping:​cawe:​reference:​mats.png|Texture Properties}} ​-> {{:​mapping:​cawe:​reference:​filter.png|Filter}} +
- +
-4. With your mouse cursor over one of the 2D views, press Enter. The brush should be selected if not, select it with the selection tool. \\ +
-{{:​mapping:​cawe:​reference:​solid.png|Dropdown Box}} +
- +
-5. Click the Entity tool\\ +
-{{:​mapping:​cawe:​reference:​tool.png|Entity Tool}} +
- +
-6. On the far right side, select "​func_water"​ from the drop down box. Click "Turn into (solid) entity type"​. +
- +
- +
-Now compile your map, and you should see water! +
- +
-====== Entity List ====== +
-This is a list of most of Ca3DE'​s brush entities, and some of its Point entities. More coming soon. +
- +
-===== Solid Entities ===== +
-Solid entities are world brushes that have extra characeristics. Note: This list is not fully complete. +
- +
-==== func_wall ==== +
-This is bascally a normal brush, except they can have transparency or "​holes"​. This entity can be used for lattice, glass, fences etc.+
  
 ==== func_illusionary ==== ==== func_illusionary ====
Line 70: Line 25:
 ==== func_pushable ==== ==== func_pushable ====
 This is an object that the player can push around the map. This is an object that the player can push around the map.
 +
 +
 +==== func_terrain ====
 +This is the entity used to add a terrain to a world. You must specify a heightmap for the terrain, and a detail texture. See [[mapping:​creatingterrainheightmaps|Creating heightmaps for your terrains]] and the NewMaterials document for more info about terrains.
  
 ===== Point Entities ===== ===== Point Entities =====
Line 80: Line 39:
  
 ==== static_detail_model ==== ==== static_detail_model ====
-//Note: This entitiy ​is specific to the Deathmatch mod.//\\ +//Note: This entity ​is specific to the Deathmatch mod.//\\ 
-This is a model that is included in a map, usually just for visual effect. You can specify an external model, how big it should be (scale), and if applicable, which animated sequence it should be performing. This entity can be used for anything that wouls be difficult to model out of brushes in CaWE. +This is a model that is included in a map, usually just for visual effect. You can specify an external model, how big it should be (scale), and if applicable, which animated sequence it should be performing. This entity can be used for anything that would be difficult to model out of brushes in CaWE. 
  
 Please note that this entity doesn'​t clip, so you need to put a clip brush around the model if you don't want the player to be able to walk through it. Please note that this entity doesn'​t clip, so you need to put a clip brush around the model if you don't want the player to be able to walk through it.
Line 95: Line 54:
   * weapon_handgrenade (Grenade)   * weapon_handgrenade (Grenade)
 Some other weapons are included, but most of them don't work. Some other weapons are included, but most of them don't work.
 +
 +==== Monsters ====
 +//Note: The following entities are specific to the Deathmatch mod.//\\
 +These are basically NPCs (Non-Player Characters). They can be animals, allies or enemies. The deathmatch mod currently contains three types of monsters:
 +   * monster_butterfly - A group of three butterflies that fly around in circles.
 +   * monster_companybot - The default Trinity bot that follows you around.
 +   * monster_eagle - An eagle which flies overhead. Requires a lot of space.
 +
 +==== Tree ====
 +FIXME I don't know what this is...
mapping/cawe/reference/entityguide.1155442203.txt.gz · Last modified: 2013-01-07 12:07 (external edit)

Page Tools

About Cafu

Cafu is an open-source game and graphics engine for multiplayer, cross-platform, real-time 3D action.

It is available to everyone as 100% free software under the GNU General Public License (GPLv3).

About the User Manual

The main Cafu documentation, the User Manual, is implemented as a Wiki: You can edit it yourself, and you are very much invited and encouraged to do so!

See Forum and Wiki login for details.

Get Involved

Learn More

Cafu Engine