nuclide/src/gs-entbase/server/func_door_rotating.qc

624 lines
14 KiB
Plaintext

/*
* Copyright (c) 2016-2022 Vera Visions LLC.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
/*QUAKED func_door_rotating (0 .5 .8) ? SF_ROT_OPEN SF_ROT_BACKWARDS x SF_ROT_PASSABLE SF_ROT_ONEWAY SF_ROT_TOGGLE SF_ROT_ZAXIS SF_ROT_XAXIS SF_ROT_USE SF_ROT_NOMONSTERS
Rotating brush door entity. It's basically the same as func_door, it just does
not move on any axis, it tilts along a pivot point defined by an origin brush.
-------- KEYS --------
"targetname" : Name
"target" : Target when triggered.
"killtarget" : Target to kill when triggered.
"speed" : Speed at which the door turns.
"snd_open" : Sound shader to play for when the door opens.
"snd_close" : Sound shader to play for when the door closes.
"snd_stop" : Sound shader to play for when the door stops rotating.
"movesnd" : Legacy integer value pointing to a predefined move sound.
"stopsnd" : Legacy integer value pointing to a predefined stop sound.
"distance" : The degrees which the door will turn.
"dmg" : The damage inflicted upon objects blocking the way of the door.
"wait" : Time that has to pass for the door to automatically close.
"netname" : Target to trigger when the door closes back up.
-------- SPAWNFLAGS --------
SF_ROT_OPEN : Door is in the open position by default.
SF_ROT_BACKWARDS : Flip the direction of a one-way door.
SF_ROT_PASSABLE : Door has no collision model to speak of.
SF_ROT_ONEWAY : Door will only open one-way as opposed to both ways.
SF_ROT_TOGGLE : Door will have to be triggered by something to open/close.
SF_ROT_ZAXIS : Door will tilt along the Z axis.
SF_ROT_XAXIS : Door will tilt on the X axis.
SF_ROT_USE : Player has to press the 'use' key to interact with it.
SF_ROT_NOMONSTERS : Monsters cannot open this door.
-------- NOTES --------
Please include an origin brush so that a pivot point will be defined.
-------- TRIVIA --------
This entity was introduced in Quake II (1997).
*/
enumflags
{
SF_ROT_OPEN,
SF_ROT_BACKWARDS,
SF_ROT_UNUSED1,
SF_ROT_PASSABLE,
SF_ROT_ONEWAY,
SF_ROT_TOGGLE,
SF_ROT_ZAXIS,
SF_ROT_XAXIS,
SF_ROT_USE,
SF_ROT_NOMONSTERS
};
#define SF_DOOR_SILENT 0x80000000i
class
func_door_rotating:NSRenderableEntity
{
string targetClose;
string m_strSndStop;
string m_strSndOpen;
string m_strSndClose;
string m_strLockedSfx;
float m_flSoundWait;
float m_flDistance;
float m_flSpeed;
float m_iState;
float m_flNextAction;
float m_flWait;
float m_flDelay;
int m_iPortalState;
int m_iDamage;
int m_iLocked;
vector m_vecDest;
vector m_vecPos1;
vector m_vecPos2;
vector m_vecMoveDir;
bool m_iCanTouch;
public:
void func_door_rotating(void);
virtual void Save(float);
virtual void Restore(string,string);
virtual void Spawned(void);
virtual void PortalOpen(void);
virtual void PortalClose(void);
virtual void Respawn(void);
virtual void Arrived(void);
virtual void Returned(void);
virtual void Back(void);
virtual void Away(void);
virtual void Trigger(entity,int);
virtual void Use(void);
virtual void Touch(entity);
virtual void Blocked(entity);
virtual void SetMovementDirection(void);
virtual void SpawnKey(string,string);
virtual void RotToDest(vector angle, void(void) func);
#ifdef GS_PHYSICS
virtual void Unhinge(void);
#endif
};
void
func_door_rotating::func_door_rotating(void)
{
targetClose = __NULL__;
m_strSndStop = __NULL__;
m_strSndOpen = __NULL__;
m_strSndClose = __NULL__;
m_strLockedSfx = __NULL__;
m_flSoundWait = 0.0f;
m_iDamage = 0i;
m_iLocked = 0i;
m_flDistance = 90.0f;
m_flSpeed = 100.0f;
m_iState = 0i;
m_flNextAction = 0.0f;
m_flWait = 0.0f;
m_flDelay = 4.0f;
m_vecDest = [0.0f, 0.0f, 0.0f];
m_vecPos1 = [0.0f, 0.0f, 0.0f];
m_vecPos2 = [0,0,0];
m_vecMoveDir = [0.0f, 0.0f, 0.0f];
m_iPortalState = 0i;
m_iCanTouch = false;
}
void
func_door_rotating::Save(float handle)
{
super::Save(handle);
SaveString(handle, "targetClose", targetClose);
SaveString(handle, "m_strSndStop", m_strSndStop);
SaveString(handle, "m_strSndOpen", m_strSndOpen);
SaveString(handle, "m_strSndClose", m_strSndClose);
SaveString(handle, "m_strLockedSfx", m_strLockedSfx);
SaveFloat(handle, "m_flSoundWait", m_flSoundWait);
SaveFloat(handle, "m_flDistance", m_flDistance);
SaveFloat(handle, "m_flSpeed", m_flSpeed);
SaveFloat(handle, "m_iState", m_iState);
SaveFloat(handle, "m_flNextAction", m_flNextAction);
SaveFloat(handle, "m_flWait", m_flWait);
SaveFloat(handle, "m_flDelay", m_flDelay);
SaveInt(handle, "m_iPortalState", m_iPortalState);
SaveInt(handle, "m_iDamage", m_iDamage);
SaveInt(handle, "m_iLocked", m_iLocked);
SaveVector(handle, "m_vecDest", m_vecDest);
SaveVector(handle, "m_vecPos1", m_vecPos1);
SaveVector(handle, "m_vecPos2", m_vecPos2);
SaveVector(handle, "m_vecMoveDir", m_vecMoveDir);
SaveBool(handle, "m_iCanTouch", m_iCanTouch);
}
void
func_door_rotating::Restore(string strKey, string strValue)
{
switch (strKey) {
case "targetClose":
targetClose = ReadString(strValue);
break;
case "m_strSndStop":
m_strSndStop = ReadString(strValue);
break;
case "m_strSndOpen":
m_strSndOpen = ReadString(strValue);
break;
case "m_strSndClose":
m_strSndClose = ReadString(strValue);
break;
case "m_strLockedSfx":
m_strLockedSfx = ReadString(strValue);
break;
case "m_flSoundWait":
m_flSoundWait = ReadFloat(strValue);
break;
case "m_flDistance":
m_flDistance = ReadFloat(strValue);
break;
case "m_flSpeed":
m_flSpeed = ReadFloat(strValue);
break;
case "m_iState":
m_iState = ReadInt(strValue);
break;
case "m_flNextAction":
m_flNextAction = ReadFloat(strValue);
break;
case "m_flWait":
m_flWait = ReadFloat(strValue);
break;
case "m_flDelay":
m_flDelay = ReadFloat(strValue);
break;
case "m_iPortalState":
m_iPortalState = ReadInt(strValue);
break;
case "m_iDamage":
m_iDamage = ReadInt(strValue);
break;
case "m_iLocked":
m_iLocked = ReadInt(strValue);
break;
case "m_vecDest":
m_vecDest = ReadVector(strValue);
break;
case "m_vecPos1":
m_vecPos1 = ReadVector(strValue);
break;
case "m_vecPos2":
m_vecPos2 = ReadVector(strValue);
break;
case "m_vecMoveDir":
m_vecMoveDir = ReadVector(strValue);
break;
case "m_iCanTouch":
m_iCanTouch = ReadInt(strValue);
break;
default:
super::Restore(strKey, strValue);
}
}
void
func_door_rotating::Spawned(void)
{
super::Spawned();
if (m_strSndOpen)
Sound_Precache(m_strSndOpen);
if (m_strSndClose)
Sound_Precache(m_strSndClose);
if (m_strSndStop)
Sound_Precache(m_strSndStop);
if (m_strLockedSfx)
Sound_Precache(m_strLockedSfx);
}
void
func_door_rotating::Respawn(void)
{
RestoreAngles();
SetMovementDirection();
ClearAngles();
#ifdef GS_PHYSICS
SetTakedamage(DAMAGE_YES);
SetHealth(100);
Death = func_door_rotating::Unhinge;
#endif
SetSolid(SOLID_BSP);
SetMovetype(MOVETYPE_PUSH);
SetModel(GetSpawnModel());
SetOrigin(GetSpawnOrigin());
ClearVelocity();
ReleaseThink();
if (spawnflags & SF_ROT_USE)
m_iCanTouch = false;
else
m_iCanTouch = true;
/* this is a terrible hack */
if (m_flWait == 0)
m_flWait = 0.01f;
if (HasSpawnFlags(SF_ROT_USE)) {
PlayerUse = Use;
} else {
PlayerUse = __NULL__;
}
m_vecPos1 = GetSpawnAngles();
if (HasSpawnFlags(SF_ROT_BACKWARDS)) {
m_vecPos2 = GetSpawnAngles() + m_vecMoveDir * -m_flDistance;
} else {
m_vecPos2 = GetSpawnAngles() + m_vecMoveDir * m_flDistance;
}
if (HasSpawnFlags(SF_ROT_OPEN)) {
vector vTemp = m_vecPos2;
m_vecPos2 = m_vecPos1;
m_vecPos1 = vTemp;
m_vecMoveDir = m_vecMoveDir * -1;
PortalOpen();
} else {
PortalClose();
}
m_iState = STATE_LOWERED;
if (HasSpawnFlags(SF_ROT_PASSABLE)) {
SetSolid(SOLID_NOT);
}
if (targetname) {
m_iLocked = TRUE;
}
SetAngles(m_vecPos1);
}
void
func_door_rotating::SpawnKey(string strKey, string strValue)
{
int x = 0;
switch (strKey) {
case "speed":
m_flSpeed = stof(strValue);
break;
/*case "lip":
m_flDistance = stof(strValue);
break;*/
case "snd_open":
m_strSndOpen = strValue;
break;
case "snd_close":
m_strSndClose = strValue;
break;
case "noise1":
m_strSndOpen = m_strSndClose = strValue;
break;
case "snd_stop":
case "noise2":
m_strSndStop = strValue;
break;
/* GoldSrc compat */
case "movesnd":
x = stoi(strValue);
m_strSndOpen = m_strSndClose = sprintf("func_door_rotating.move_%i", x);
break;
case "stopsnd":
x = stoi(strValue);
m_strSndStop = sprintf("func_door_rotating.stop_%i", x);
break;
case "distance":
m_flDistance = stof(strValue);
break;
case "dmg":
m_iDamage = stoi(strValue);
break;
case "wait":
m_flWait = stof(strValue);
break;
case "netname":
targetClose = strValue;
break;
case "locked_sound":
x = stoi(strValue);
m_strLockedSfx = sprintf("func_button.hlsfx_%i", x+1i);
break;
default:
super::SpawnKey(strKey, strValue);
}
}
void
func_door_rotating::PortalOpen(void)
{
if (m_iPortalState == 1)
return;
m_iPortalState = 1;
setorigin(this, origin);
openportal(this, AREAPORTAL_OPEN);
}
void
func_door_rotating::PortalClose(void)
{
if (m_iPortalState == 0)
return;
m_iPortalState = 0;
setorigin(this, origin);
openportal(this, AREAPORTAL_CLOSED);
}
#ifdef GS_PHYSICS
void
func_door_rotating::Unhinge(void)
{
SetTakedamage(DAMAGE_NO);
ReleaseThink();
m_iCanTouch = false;
SetSolid(SOLID_PHYSICS_BOX);
SetMovetype(MOVETYPE_PHYSICS);
physics_enable(this, TRUE);
}
#endif
void
func_door_rotating::Arrived(void)
{
SetAngles(m_vecDest);
SetAngularVelocity([0,0,0]);
ReleaseThink();
m_iState = STATE_RAISED;
if (m_strSndStop) {
Sound_Play(this, CHAN_VOICE, m_strSndStop);
} else {
sound(this, CHAN_VOICE, "common/null.wav", 1.0f, ATTN_NORM);
}
if ((m_flWait < 0.0f) || HasSpawnFlags(SF_ROT_TOGGLE) == true)
return;
ScheduleThink(Back, m_flWait);
}
void
func_door_rotating::Returned(void)
{
SetAngles(m_vecDest);
SetAngularVelocity([0,0,0]);
ReleaseThink();
if (m_strSndStop) {
Sound_Play(this, CHAN_VOICE, m_strSndStop);
} else {
sound(this, CHAN_VOICE, "common/null.wav", 1.0f, ATTN_NORM);
}
if (targetClose)
for (entity f = world; (f = find(f, ::targetname, targetClose));) {
NSEntity trigger = (NSEntity)f;
if (trigger.Trigger != __NULL__) {
trigger.Trigger(this, TRIG_TOGGLE);
}
}
m_iState = STATE_LOWERED;
PortalClose();
}
void
func_door_rotating::Back(void)
{
if (!HasSpawnFlags(SF_DOOR_SILENT)) {
if (m_strSndClose) {
Sound_Play(this, CHAN_VOICE, m_strSndClose);
} else {
sound(this, CHAN_VOICE, "common/null.wav", 1.0f, ATTN_NORM);
}
}
m_iState = STATE_DOWN;
RotToDest(m_vecPos1, Returned);
}
void
func_door_rotating::Away(void)
{
float fDirection = 1.0;
if (m_iState == STATE_UP) {
return;
}
if (!HasSpawnFlags(SF_DOOR_SILENT)) {
if (m_strSndOpen) {
Sound_Play(this, CHAN_VOICE, m_strSndOpen);
} else {
sound(this, CHAN_VOICE, "common/null.wav", 1.0f, ATTN_NORM);
}
}
m_iState = STATE_UP;
if (!HasSpawnFlags(SF_ROT_ONEWAY)) {
/* One way doors only work on the Y axis */
if (!HasSpawnFlags(SF_ROT_ZAXIS) || HasSpawnFlags(SF_ROT_XAXIS)) {
/* get the door facing dir */
vector door_dir = vectoangles(WorldSpaceCenter() - origin);
makevectors(door_dir);
float flDir = dotproduct(origin - eActivator.origin, v_right);
if (flDir > 0) {
fDirection = -1.0f;
}
}
}
RotToDest(m_vecPos2 * fDirection, Arrived);
PortalOpen();
}
void
func_door_rotating::Trigger(entity act, int state)
{
if (GetMaster() == FALSE) {
return;
}
if (m_flNextAction > time) {
return;
}
m_flNextAction = time + m_flWait;
eActivator = act;
if (state == TRIG_TOGGLE) {
if ((m_iState == STATE_UP) || (m_iState == STATE_RAISED)) {
Back();
return;
} else {
Away();
}
} else if (state == TRIG_OFF) {
Back();
} else if (state == TRIG_ON) {
Away();
}
UseTargets(act, TRIG_TOGGLE, m_flDelay);
}
void
func_door_rotating::Use(void)
{
eActivator.flags &= ~FL_USE_RELEASED;
Trigger(eActivator, TRIG_TOGGLE);
}
void
func_door_rotating::Touch(entity eToucher)
{
if (m_iCanTouch == false)
return;
if (m_iLocked || !GetMaster()) {
if (m_flSoundWait < time)
Sound_Play(this, CHAN_VOICE, m_strLockedSfx);
m_flSoundWait = time + 0.3f;
return;
}
if (HasSpawnFlags(SF_ROT_USE)) {
return;
}
if ((m_iState == STATE_UP) || (m_iState == STATE_DOWN)) {
return;
}
if (eToucher.movetype == MOVETYPE_WALK) {
Trigger(eToucher, TRIG_TOGGLE);
}
}
void
func_door_rotating::Blocked(entity eBlocker)
{
if (m_iDamage) {
Damage_Apply(eBlocker, this, m_iDamage, 0, DMG_CRUSH);
}
if (m_flWait >= 0) {
if (m_iState == STATE_DOWN) {
Away();
} else {
Back();
}
}
}
void
func_door_rotating::SetMovementDirection(void)
{
if (HasSpawnFlags(SF_ROT_ZAXIS)) {
m_vecMoveDir = [0,0,1];
} else if (HasSpawnFlags(SF_ROT_XAXIS)) {
m_vecMoveDir = [1,0,0];
} else {
m_vecMoveDir = [0,1,0];
}
}
void
func_door_rotating::RotToDest(vector vDestAngle, void(void) func)
{
vector vecAngleDifference;
float flTravelLength, flTravelTime;
if (!m_flSpeed) {
NSLog("^1func_door_rotating::^3RotToDest^7: No speed defined for %s!", targetname);
Respawn();
return;
}
vecAngleDifference = (vDestAngle - angles);
flTravelLength = vlen(vecAngleDifference);
flTravelTime = (flTravelLength / m_flSpeed);
/* Avoid NAN hack */
if (flTravelTime <= 0.0f) {
ScheduleThink(func, 0.0f);
} else {
avelocity = (vecAngleDifference * (1 / flTravelTime));
m_vecDest = vDestAngle;
ScheduleThink(func, flTravelTime);
}
}