Nuclide
Software Development Kit for id Technology (BETA)
Loading...
Searching...
No Matches
Mover.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
18typedef enum
19{
20 MOVER_POS1,
21 MOVER_POS2,
22 MOVER_1TO2,
23 MOVER_2TO1
24} moverState_t;
25
27typedef enum
28{
29 MOVERTYPE_LINEAR,
30 MOVERTYPE_ACCELERATED,
31} moverType_t;
32
33
34#define AREAPORTAL_CLOSED 0
35#define AREAPORTAL_OPEN 1
36
45class
47{
48public:
49 void ncMoverEntity(void);
50
52 nonvirtual vector GetDirectionalPosition(vector, float);
54 nonvirtual vector GetDirectionalRotation(vector, float);
55
57 nonvirtual void SetMoverState(moverState_t);
59 nonvirtual moverState_t GetMoverState(void);
60
62 nonvirtual void SetMoverType(moverType_t);
64 nonvirtual moverType_t GetMoverType(void);
65
67 nonvirtual void SetMoverPosition1(vector);
69 nonvirtual vector GetMoverPosition1(void);
70
72 nonvirtual void SetMoverPosition2(vector);
74 nonvirtual vector GetMoverPosition2(void);
75
77 nonvirtual void SetMoverRotation1(vector);
79 nonvirtual vector GetMoverRotation1(void);
80
82 nonvirtual void SetMoverRotation2(vector);
84 nonvirtual vector GetMoverRotation2(void);
85
87 nonvirtual void MoveToPosition(vector, float);
89 nonvirtual void RotateToPosition(vector, float);
91 nonvirtual void MoveAndRotateToPosition(vector, vector, float);
92
94 nonvirtual void MoveToReverse(float);
96 nonvirtual void RotateToReverse(float);
98 nonvirtual bool IsMoving(void);
99
101 virtual void MoverStartsMoving(void);
103 virtual void MoverFinishesMoving(void);
104
105 /* overrides */
106#ifdef SERVER
107 virtual void Save(float);
108 virtual void Restore(string, string);
109 virtual void SpawnKey(string, string);
110#endif
111
112private:
113 vector m_vecPos1;
114 vector m_vecPos2;
115 vector m_vecPos3;
116 vector m_vecPos4;
117 moverState_t m_moverState;
118 moverType_t m_moverType;
119 int m_iPortalState;
120 vector m_vecMoveDir; /* movedir override from Source */
121 bool m_bUseMoveDir;
122
123 nonvirtual void _PortalOpen(void);
124 nonvirtual void _PortalClose(void);
125 nonvirtual void _ArrivedAtRotPosition1(void);
126 nonvirtual void _ArrivedAtRotPosition2(void);
127 nonvirtual void _BeginMoving(void);
128};
void ncMoverEntity(void)
Definition Mover.qc:18
nonvirtual void MoveToPosition(vector, float)
Moves this entity to the specified position.
Definition Mover.qc:212
nonvirtual void SetMoverPosition1(vector)
Sets the initial starting position.
Definition Mover.qc:164
nonvirtual void MoveToReverse(float)
Moves to the reverse state.
Definition Mover.qc:291
nonvirtual void SetMoverState(moverState_t)
Set the movement state.
Definition Mover.qc:139
nonvirtual vector GetDirectionalRotation(vector, float)
Returns a directional angle from the current one.
Definition Mover.qc:124
nonvirtual vector GetMoverPosition1(void)
Returns the starting position.
Definition Mover.qc:170
nonvirtual moverType_t GetMoverType(void)
Returns the movement type.
Definition Mover.qc:157
virtual void MoverStartsMoving(void)
Overridable: Called when the mover starts moving from its position to another.
Definition Mover.qc:408
virtual void Restore(string, string)
Similar to ncIO::SpawnKey() but for save-game fields.
Definition Mover.qc:61
nonvirtual void RotateToReverse(float)
Rotates to the reversed state.
Definition Mover.qc:307
nonvirtual void SetMoverPosition2(vector)
Sets the final destination.
Definition Mover.qc:176
nonvirtual void MoveAndRotateToPosition(vector, vector, float)
Moves and rotates this entity to a desired location.
Definition Mover.qc:218
nonvirtual void SetMoverRotation2(vector)
Sets the final destination angle.
Definition Mover.qc:200
nonvirtual void RotateToPosition(vector, float)
Rotates this entity to the desired angle.
Definition Mover.qc:301
nonvirtual vector GetDirectionalPosition(vector, float)
Returns a directional position from the current one.
Definition Mover.qc:98
virtual void MoverFinishesMoving(void)
Overridable: Called when the mover completes its movement to a destination.
Definition Mover.qc:413
nonvirtual vector GetMoverPosition2(void)
Returns the final destination.
Definition Mover.qc:182
virtual void Save(float)
Handles saving a copy of this entity to a given filehandle.
Definition Mover.qc:45
nonvirtual vector GetMoverRotation2(void)
Returns the final destination angle.
Definition Mover.qc:206
virtual void SpawnKey(string, string)
This method handles entity key/value pairs on map load.
Definition Mover.qc:32
nonvirtual void SetMoverType(moverType_t)
Set the movement type.
Definition Mover.qc:151
nonvirtual moverState_t GetMoverState(void)
Returns the movement state.
Definition Mover.qc:145
nonvirtual vector GetMoverRotation1(void)
Returns the starting angle.
Definition Mover.qc:194
nonvirtual bool IsMoving(void)
Returns if the ncMoverEntity is currently moving.
Definition Mover.qc:317
nonvirtual void SetMoverRotation1(vector)
Sets the initial starting angle.
Definition Mover.qc:188
void ncSurfacePropEntity(void)
Definition SurfacePropEntity.qc:18