Fieldname

Entity Fieldnames

List of fields supported by et.gentity_get() and et.gentity_set() functions

field type access activator entity RO chain entity RW classname string RW client.inactivityTime integer RW client.inactivityWarning qboolean RW clipmask integer ? closespeed float RW count integer RW count2 integer RW damage integer RW deathType meansOfDeath_t RW delay float RW dl_atten integer RW dl_color vec3 RW dl_shader string RO dl_stylestring string RO duration float RW end_size integer RW enemy entity RW flags bitflag RO harc float RW health integer RW inuse qboolean RO isProp qboolean RO item string RW key integer RW message string RW methodOfDeath integer RW mg42BaseEnt integer RW missionLevel integer RW model string RO model2 string RO nextTrain entity RW noise_index integer RW origin vec3 RW pers.connected connected_t ? pers.netname string ? pers.localClient qboolean ? pers.initialSpawn qboolean ? pers.enterTime integer ? pers.connectTime integer ? pers.teamState.state teamstatestate_t ? pers.voteCount integer ? pers.teamVoteCount integer ? pers.complaints integer ? pers.complaintClient integer ? pers.complaintEndTime integer ? pers.lastReinforceTime integer ? pers.applicationClient integer ? pers.applicationEndTime integer ? pers.invitationClient integer ? pers.invitationEndTime integer ? pers.propositionClient integer ? pers.propositionClient2 integer ? pers.propositionEndTime integer ? pers.autofireteamEndTime integer ? pers.autofireteamCreateEndTime integer ? pers.autofireteamJoinEndTime integer ? pers.lastSpawnTime integer ? pers.ready qboolean ? prevTrain entity RW props_frame_state integer RO ps.stats integer array RW ps.persistant integer array RW ps.ping integer ? ps.powerups integer array RW ps.ammo integer array RW ps.ammoclip integer array RW r.absmax vec3 RO r.absmin vec3 RO r.bmodel qboolean RO r.contents integer RW r.currentAngles vec3 RW r.currentOrigin vec3 RW r.eventTime integer RW r.linkcount integer RO r.linked qboolean RO r.maxs vec3 RW r.mins vec3 RW r.ownerNum integer RW r.singleClient integer RW r.svFlags integer RW r.worldflags integer RO radius integer RW random float RW rotate vec3 RW s.angles vec3 RW s.angles2 vec3 RW s.apos trajectory RW s.clientNum integer RW s.constantLight integer RW s.density integer RW s.dl_intensity integer RW s.dmgFlags integer RW s.eFlags integer RW s.eType integer ? s.effect1Time integer RW s.effect2Time integer RW s.effect3Time integer RW s.frame integer RW s.groundEntityNum integer RO s.loopSound integer RW s.modelindex integer RW s.modelindex2 integer RW s.number integer RO s.onFireEnd integer RW s.onFireStart integer RW s.origin vec3 ? s.origin2 vec3 ? s.pos trajectory RW s.powerups integer RO s.solid integer RW s.teamNum integer RW s.time integer RW s.time2 integer RW s.weapon integer RO scriptName string RO sess.sessionTeam team_t RW sess.spectatorTime integer RW sess.spectatorState spectatorState_t RW sess.spectatorClient entity RW sess.latchSpectatorClient integer RW sess.playerType integer RW sess.playerWeapon integer RW sess.playerWeapon2 integer RW sess.spawnObjectiveIndex integer RW sess.latchPlayerType integer RW sess.latchPlayerWeapon integer RW sess.latchPlayerWeapon2 integer RW sess.damage_given integer RW sess.damage_received integer RW sess.deaths integer RW sess.game_points integer RW sess.gibs integer RW sess.kills integer RW sess.medals integer array RW sess.muted qboolean RW sess.rank integer RW sess.referee integer RW sess.rounds integer RW sess.semiadmin integer RW sess.skill integer array RW sess.spec_invite integer RW sess.spec_team integer RW sess.suicides integer RW sess.team_damage integer RW sess.team_kills integer RW sess.team_received integer RW sess.aWeaponStats weapon_stat_t RW spawnflags integer RO spawnitem string RO speed float RW splashDamage integer RW splashMethodOfDeath integer RW splashRadius integer RW start_size integer RW tagName string RO tagParent entity RW takedamage boolean RW tankLink entity RW target string RW TargetAngles vec3 RW TargetFlag integer RO targetname string RO teamchain entity RW teammaster entity RW track string RO varc float RW wait float RW waterlevel integer RO watertype integer RO

note: all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.

note: all array variables need to be get or set with an additional parameter.

---

ET variable types

qboolean

a qboolean is a boolean value.

0 is represented by the lua value false

1 is represented by the lua value true

---

vec3

a vec3_t is a 3-element array of numbers (C definition: typedef float vec3_t[3];). It is usually used to store and process coordinates in 3D space.

In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by

doing:

origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]

---

array

The fields listed as having type array represent an entity value which is an array. Individual elements of the array are accessed by passing the desired index in the arrayindex argument to the et.gentity_get and et.gentity_set functions. Valid array indexes are integers from 0 up to some field specific maximum. The arrayindex argument is required when accessing array type fields, so only one element of an array can be accessed in a given call to the gentity_* functions.

---

trajectory

a trajectory is returned as a lua table described below

{
  trDuration = <number>, --- int
  trTime = <number>, -- int
  trType = <number>, -- see below for allowed values
  trBase = <vec3_t>, -- vec3, as described above
  trDelta = <vec3_t> -- also a vec3
}

the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note

that not all values make sense for all entity types

number type discription 1 TR_STATIONARY   2 TR_INTERPOLATE non-parametric, but interpolate between snapshots 3 TR_LINEAR   4 TR_LINEAR_STOP   5 TR_LINEAR_STOP_BACK reverse movement can be different than forward 6 TR_SINE value = base + sin( time / duration ) * delta 7 TR_GRAVITY   8 TR_GRAVITY_LOW   9 TR_GRAVITY_FLOAT super low grav with no gravity acceleration 10 TR_GRAVITY_PAUSED has stopped, but trace to see if it should be switched back to TR_GRAVITY 11 TR_ACCELERATE   12 TR_DECCELERATE   13 TR_SPLINE   14 TR_LINEAR_PATH

---

entity

The fields listed as having type enitity return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:

0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password

0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)

1022 is the worldspawn entity

1023 is ENTITYNUM_NONE which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.

Note: Some other fields not listed as type 'entity' may take an entity number value. mg42BaseEnt and s.number are examples.

---

meansOfDeath

a meansOfDeath_t is a number indicating the Method of Death Click here for a list with possible value's

Field details

WARNING The following are incomplete, and likely contain errors. Also be aware that the meaning of many fields depends on which entity the field belongs to. "damage" on one entity may have a completely different meaning on another. When in doubt, consult the ET source. ETPro may differ slightly, but the majority of entity fields are the same. The full meaning of a given field can ONLY be obtained from the source.

classname

Entity class name.

• nil if entity is not in use
• player for game client
• team_WOLF_objective for objective entity

etc.

client.inactivityTime

Timestamp of when the client was last active. Seems to be 44000000 + server uptime in ms.

damage

Probably related to damage entity deals (e.g. fire, barbed wire). 2 for player entity.

health

Health of the entity (e.g. player's health for a client, damage needed to disable stationary MG for stationary MG etc.)

inuse

Indicates whether the entity number is used. Specially for entity numbers reserved for clients, indicates whether client slot is used.

message

Message associated with the entity (e.g. "Side door" for side door objective entity). nil for player entities.

origin

• for living player and some visible entities (like tank), position in map
• dosen't work for spectating player

s.origin

• for spectator in freelook, the spectator's position

pers.netname

For player, their nickname.

ps.ammo

Array. For each weapon, tells how many bullets/whatever the player has in spare clips.

ps.ammoclip

Array. For each weapon, tells how many bullets/whatever the player has in current clip.

sess.sessionTeam

Player's team:

• 1 = red
• 2 = blue
• 3 = spectator

sess.spectatorState

• 1 = free spectator
• 2 = spectator following another player

sess.spectatorClient

Entity number of player the spectator is following.