Entity - Revision history

VorteX at 12:39, 25 September 2012

2012-09-25T12:39:07Z

VorteX at 12:38, 25 September 2012

2012-09-25T12:38:52Z

VorteX: /* Fields classification */

2012-07-22T19:26:35Z

‎Fields classification

VorteX at 19:26, 22 July 2012

2012-07-22T19:26:13Z

VorteX: /* Game entity structure */

2012-07-22T19:24:21Z

‎Game entity structure

VorteX at 19:24, 22 July 2012

2012-07-22T19:24:05Z

VorteX at 19:23, 22 July 2012

2012-07-22T19:23:30Z

VorteX at 19:22, 22 July 2012

2012-07-22T19:22:46Z

VorteX at 19:22, 22 July 2012

2012-07-22T19:22:28Z

VorteX at 19:22, 22 July 2012

2012-07-22T19:22:13Z

@@ Line 24: / Line 24: @@
   _ls - q3map2 field, sets scale of lightmaps to be generated for entity surfaces
-=== Other entities ===
+== Other entities ==
 Game entity represents server entity - entity spawned and processed on server programs. There are more entitity types created and processed in other programs:

@@ Line 1: / Line 1: @@
 '''Entity''' (edict, object) - any object in game world. Players, Monsters, Items etc. are entities.
-There is 3 types of game entities, depends on what programs they exists:
+== Game entity ==
-* Game entity
+Each game entity have unique number (a position in entities array) and set of fields. Set of fields are shared between all entities, but their usage is based on entity class and subclass functions.  It means if "health" field is defined, any entity can access it, but based on entity class, it can have different meaning. There is system fields used by engine routines (spawnflags, movetype).
-** Server entity (actual game entity, get saved to savegames)
-** Client entity (networked game entity on a client)
-** Menu entity (exists only in menu program which is a separated from a client because client program get unloaded when level changes)
-* Network entity - legacy engine-based networking (not using client-side progs)
-* Render entity - a Network/Client entity that is sent to render.
-=== Game entity structure ===
+Entity fields can be one of 5 types:
-Each game entity have:
+Depending of engine build, strings could be from 1024(game build) to 16384 (developer build) characters long. Max entities is also 2048 in game build and 128k in development build.
-* entity number (index in global entity storage)
-* fields (or keys) - all entity properties.
-Entity behavior is defined by it's fields.
+When game is saved engine writes all entity keys except ones prefixed with ''_''. This fields are meant to be runtime-only.
 Example of entity fields:
   origin - position or entity in the world space
-  health - health of entity
+  health - health of monster/trigger
-  classname - entity class name
+  classname - entity class name (a function called after entity get spawned)
   th_die - internal game field, a game function to call when monster dies
   _next - system field used by entity chain routines
   _ls - q3map2 field, sets scale of lightmaps to be generated for entity surfaces
-In QuakeC, all entities shares the same fieldset. But on different entity classes, same fields can have different functionality.
+=== Other entities ===
-==== Fields classification ====
+* Client entity (networked game entity on a client)
+* Menu entity (exists only in menu program which is a separated from a client because client program get unloaded when level changes)
-* Common field - field of entity that can be set in level editor (such as '''origin''')
+* Render entity - entity that is sent to render.
-* Gamecode field - this one is being set by gamecode, not accessible in level editor ('''th_die''' is an example)
-* Non-Saved field - not saved to a savegame field, this fields always prefixed by _ ('''_next''' field).
-* Compiler-only field - this field dont exist in the game logic and only used by Q3map2 to guide compilation of map ('''_ls''' field).
 [[Category:Glossary]]

@@ Line 31: / Line 31: @@
 * Common field - field of entity that can be set in level editor (such as '''origin''')
-* Gamecode field - this one is being set by gamecode, not acessible in level editor ('''th_die''' is an example)
+* Gamecode field - this one is being set by gamecode, not accessible in level editor ('''th_die''' is an example)
 * Non-Saved field - not saved to a savegame field, this fields always prefixed by _ ('''_next''' field).
 * Compiler-only field - this field dont exist in the game logic and only used by Q3map2 to guide compilation of map ('''_ls''' field).
 [[Category:Glossary]]

@@ Line 19: / Line 19: @@
 Example of entity fields:
   health - health of entity
   classname - entity class name
   th_die - internal game field, a game function to call when monster dies
   _ls - q3map2 field, sets scale of lightmaps to be generated for entity surfaces
@@ Line 29: / Line 31: @@
 * Common field - field of entity that can be set in level editor (such as '''origin''')
-* Gamecode field - this one is being set by gamecode, not acessible in level editor
+* Gamecode field - this one is being set by gamecode, not acessible in level editor ('''th_die''' is an example)
-* Non-Saved field - not saved to a savegame filed, this fields always prefixed by _.
+* Non-Saved field - not saved to a savegame field, this fields always prefixed by _ ('''_next''' field).
-* Compiler-only field - this field dont exist in the game logic and only used by Q3map2 to guide compilation of map.
+* Compiler-only field - this field dont exist in the game logic and only used by Q3map2 to guide compilation of map ('''_ls''' field).
 [[Category:Glossary]]

@@ Line 16: / Line 16: @@
 * fields (or keys) - all entity properties.
-Entity behavior is set by it's fields.
+Entity behavior is defined by it's fields.
 Example of entity fields:

@@ Line 14: / Line 14: @@
 Each game entity have:
 * entity number (index in global entity storage)
-* entity class (code-drived behavior)
+* entity class (code-driven behavior)
 * fields (or keys) - entity properties.

← Older revision		Revision as of 19:22, 22 July 2012
Line 1:		Line 1:
	'''Entity''' (edict, object) - any object in game world. Players, Monsters, Items etc. are entities.		'''Entity''' (edict, object) - any object in game world. Players, Monsters, Items etc. are entities.
−
−	~~=== Entity types ===~~

	There is 3 types of game entities, depends on what programs they exists:		There is 3 types of game entities, depends on what programs they exists: