Nuclide
Software Development Kit for id Technology
entities.h
1/*
2 * Copyright (c) 2016-2024 Vera Visions LLC.
3 *
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
13 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
14 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15*/
16
17/* used to keep track of decl across different classnames */
18.string declclass;
19
35typedef enum
36{
88
89
92entity
93Entity_FindClosest(entity startTarget, string className)
94{
95 entity best = world;
96 float bestdist;
97 float dist;
98
99 bestdist = 9999999;
100
101 for (entity e = world; (e = find(e, classname, className));) {
102 dist = vlen(startTarget.origin - e.origin);
103
104 if (dist < bestdist) {
105 bestdist = dist;
106 best = e;
107 }
108 }
109
110 return best;
111}
112
113
116entity
117Entity_SelectRandom(string className)
118{
119 entity spot = world;
120 int max = 0i;
121
122 /* count the total number of entities of the desired class */
123 for (entity e = world; (e = find(e, ::classname, className));) {
124 max++;
125 }
126
127 /* immediately exit out if we've got none */
128 if (max < 1i) {
129 NSError("%S is not present on this map.", className);
130 return __NULL__;
131 }
132
133 /* select a random point */
134 for (int i = random(1, max); i > 0; i--) {
135 spot = find(spot, ::classname, className);
136 }
137
138 /* we might end up not finding anything, wrap around? */
139 if (spot == __NULL__) {
140 spot = find(spot, ::classname, className);
141 }
142
143 /* we should have returned something valid now */
144 return spot;
145}
146
147 // end of entities
entupdate_t
Entity update identifiers.
Definition: entities.h:36
entity Entity_FindClosest(entity startTarget, string className)
Returns the closest point entity of a given classname.
Definition: entities.h:93
entity Entity_SelectRandom(string className)
Returns a random entity of a given classname.
Definition: entities.h:117
@ ENT_SPRITE
of type env_sprite
Definition: entities.h:67
@ ENT_RAGDOLL
of type NSRagdoll
Definition: entities.h:51
@ ENT_GLOW
of type env_glow
Definition: entities.h:68
@ ENT_MONITOR
of type func_monitor
Definition: entities.h:72
@ ENT_PARTSYSTEM
of type info_particle_system
Definition: entities.h:66
@ ENT_ENTITY
of type NSEntity
Definition: entities.h:38
@ ENT_CASCADELIGHT
of type env_cascade_light
Definition: entities.h:64
@ ENT_NONE
invalid, but reserved.
Definition: entities.h:37
@ ENT_SPECTATOR
of type NSClientSpectator
Definition: entities.h:52
@ ENT_TALKMONSTER
of type NSTalkMonster
Definition: entities.h:46
@ ENT_SPRAY
of type NSSpraylogo
Definition: entities.h:69
@ ENT_VEH_TANKMORTAR
of type func_tankmortar
Definition: entities.h:76
@ ENT_SOUNDSCAPE
of type NSSoundScape
Definition: entities.h:85
@ ENT_WEAPON
of type NSWeapon
Definition: entities.h:50
@ ENT_PORTAL
of type NSPortal
Definition: entities.h:53
@ ENT_SURFPROP
of type NSSurfacePropEntity
Definition: entities.h:43
@ ENT_PROJECTEDTEXTURE
of type env_projectedtexture
Definition: entities.h:59
@ ENT_SPEAKER
of type speaker
Definition: entities.h:47
@ ENT_OLDCAMERA
of type trigger_camera
Definition: entities.h:71
@ ENT_ITEM
of type NSItem
Definition: entities.h:49
@ ENT_FOG
of type env_fog
Definition: entities.h:61
@ ENT_FOGCONTROLLER
of type env_fog_controller
Definition: entities.h:63
@ ENT_STEAM
of type env_steam
Definition: entities.h:62
@ ENT_SEPARATOR
This is a separator.
Definition: entities.h:86
@ ENT_LASER
of type env_laser
Definition: entities.h:65
@ ENT_FUNNEL
of type env_funnel
Definition: entities.h:56
@ ENT_VEHICLE
Reserved.
Definition: entities.h:73
@ ENT_PUSH
of type trigger_push
Definition: entities.h:84
@ ENT_SMOKER
of type env_smoker
Definition: entities.h:57
@ ENT_TRACKTRAIN
of type func_tracktrain
Definition: entities.h:74
@ ENT_DLIGHT
of type light_dynamic
Definition: entities.h:58
@ ENT_AMBIENTSOUND
of type ambient_generic
Definition: entities.h:54
@ ENT_VEH_BRUSH
of type func_vehicle
Definition: entities.h:75
@ ENT_WAYPOINT
of type info_waypoint
Definition: entities.h:82
@ ENT_PROPROPE
of type prop_rope
Definition: entities.h:78
@ ENT_PHYSICS
of type NSPhysicsEntity
Definition: entities.h:44
@ ENT_BEAM
of type env_beam
Definition: entities.h:55
@ ENT_ENTITYPROJECTILE
of type NSProjectile
Definition: entities.h:42
@ ENT_INSTRUCTOR
of type env_instructor_hint
Definition: entities.h:83
@ ENT_SPOTLIGHT
of type point_spotlight
Definition: entities.h:60
@ ENT_PLAYER
of type NSClientPlayer
Definition: entities.h:48
@ ENT_PHYSROPE
of type phys_rope
Definition: entities.h:79
@ ENT_ENTITYRENDERABLE
of type NSRenderableEntity
Definition: entities.h:41
@ ENT_PMOVEVARS
of type NSPMoveVars
Definition: entities.h:40
@ ENT_MONSTER
of type NSMonster
Definition: entities.h:45
@ ENT_SOUND
of type NSSound
Definition: entities.h:39
@ ENT_CONVEYOR
of type func_conveyor
Definition: entities.h:81
@ ENT_DECAL
of type NSDecal
Definition: entities.h:70
@ ENT_BUBBLES
of type env_bubbles
Definition: entities.h:80
@ ENT_VEH_4WHEEL
of type prop_vehicle_driveable
Definition: entities.h:77
string classname
Definition: ui.qc:430