Nuclide
Software Development Kit for id Technology (BETA)
Loading...
Searching...
No Matches
SquadMonster.h
1/*
2 * Copyright (c) 2023 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#define NSSQUADMONSTER_MAXMEMBERS 5
18
22class
24{
25public:
26 void ncSquadMonster(void);
27
28#ifdef SERVER
29 /* overrides */
30 virtual void Spawned(void);
31 virtual void SpawnKey(string, string);
32 virtual void Input(entity, string, string);
33 virtual void Save(float);
34 virtual void Restore(string, string);
35
37 virtual void HasBecomeSquadLeader(void);
39 virtual void HasJoinedSquad(void);
40
42 nonvirtual bool InSquad(void);
44 nonvirtual bool IsSquadLeader(void);
46 nonvirtual ncSquadMonster GetSquadLeader(void);
47
49 nonvirtual void FindSquadNearMe(float);
50
52 nonvirtual void AddToSquad(ncSquadMonster);
54 nonvirtual void RemoveFromSquad(ncSquadMonster);
60 nonvirtual void AlertSquadWithMindset(string scheduleType);
61#endif
62
63#ifdef SERVER
64private:
65 string m_strSquadLeaderBody;
66 bool m_bStartAsLeader;
67 bool m_inSquad;
68 ncSquadMonster m_eSquadLeader;
69
70 /* stored only in the squad leader's memory */
71 ncSquadMonster m_eSquadMembers[NSSQUADMONSTER_MAXMEMBERS];
72#endif
73};
void ncMonster(void)
Definition Monster.qc:21
virtual void Spawned(void)
Called when the entity is fulled initialized.
Definition SquadMonster.qc:132
virtual void Input(entity, string, string)
Called when we are being prompted by another object/function with an input message.
Definition SquadMonster.qc:50
nonvirtual ncSquadMonster GetNearestSquadMember(void)
Returns the nearest available member of its squad.
Definition SquadMonster.qc:274
nonvirtual bool InSquad(void)
Returns true/false if they're in a squad.
Definition SquadMonster.qc:162
nonvirtual void FindSquadNearMe(float)
Will find and attach to a Squad in the specified radius.
Definition SquadMonster.qc:183
nonvirtual void RemoveFromSquad(ncSquadMonster)
Will remove the specified NPC from this entity's current squad.
Definition SquadMonster.qc:250
virtual void Restore(string, string)
Similar to ncIO::SpawnKey() but for save-game fields.
Definition SquadMonster.qc:95
nonvirtual void AddToSquad(ncSquadMonster)
Will add the specified NPC to this entity's current squad.
Definition SquadMonster.qc:205
virtual void HasBecomeSquadLeader(void)
Overridable: Called when this NPC became squad leader.
Definition SquadMonster.qc:150
nonvirtual ncSquadMonster GetFarthestSquadMember(void)
Returns the farthest available member of its squad.
Definition SquadMonster.qc:311
nonvirtual bool IsSquadLeader(void)
Returns whether or not they're the squad leader.
Definition SquadMonster.qc:168
nonvirtual ncSquadMonster GetSquadLeader(void)
Returns the leader of their squad.
Definition SquadMonster.qc:177
void ncSquadMonster(void)
Definition SquadMonster.qc:18
virtual void SpawnKey(string, string)
This method handles entity key/value pairs on map load.
Definition SquadMonster.qc:64
virtual void HasJoinedSquad(void)
Overridable: Called when this NPC joined a squad.
Definition SquadMonster.qc:156
nonvirtual void AlertSquadWithMindset(string scheduleType)
Informs out squad of our new mindset.
Definition SquadMonster.qc:35
virtual void Save(float)
Handles saving a copy of this entity to a given filehandle.
Definition SquadMonster.qc:79