TalkMonster.h

/*
 * 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.
*/
 
/* NPCs are more advanced than regular monsters in that they express emotions
 * and are able to interact more with the environment */
 
#ifdef SERVER
#define PLAYER_DETECT_RADIUS 512
 
enumflags
{
    MONSTER_USED,
    MONSTER_FEAR,
    MONSTER_METPLAYER,
    MONSTER_CANFOLLOW
};
#endif
 
class ncTalkMonster:ncSquadMonster
{
public:
    void ncTalkMonster(void);
 
    virtual void Sentence(string);
 
#ifdef SERVER
    virtual void Speak(string);
    virtual void WarnAllies(void);
    virtual void StartleAllies(void);
    virtual void FollowPlayer(void);
    virtual void FollowChain(void);
    virtual void RunAI(void);
    virtual void PanicFrame(void);
 
    virtual void OnPlayerUse(void);
    //virtual void Hide(void);
    virtual void Respawn(void);
    virtual void Input(entity,string,string);
    virtual void SpawnKey(string,string);
    virtual float SendEntity(entity,float);
    virtual void Save(float);
    virtual void Restore(string,string);
    virtual void Touch(entity);
 
    /*virtual void(void) TalkAnswer;
    virtual void(void) TalkAsk;
    virtual void(void) TalkAllyShot;
    virtual void(void) TalkGreet;
    virtual void(void) TalkIdle;
    virtual void(void) TalkHearing;
    virtual void(void) TalkSmelling;
    virtual void(void) TalkStare;
    virtual void(void) TalkSurvived;
    virtual void(void) TalkWounded;*/
 
    virtual void TalkPanic(void);
    virtual void TalkPlayerAsk(void);
    virtual void SeenPlayer(ncActor);
    virtual void SeenFriend(ncActor);
    virtual void TalkPlayerWounded1(void);
    virtual void TalkPlayerWounded2(void);
    virtual void TalkPlayerWounded3(void);
    virtual void TalkUnfollow(void);
    virtual void TalkFollow(void);
    virtual void TalkStopFollow(void);
    virtual void TalkDenyFollow(void);
 
    nonvirtual void SetSentencePitch(float);
#endif
 
#ifdef CLIENT
    virtual float predraw(void);
    virtual void ReceiveEntity(float,float);
 
    virtual void SentenceSample(string);
    virtual void ProcessWordQue(void);
#endif
 
    /* model events */
    virtual void HandleAnimEvent(float,int,string);
 
private:
#ifdef SERVER
    /* our NPCs can have a unique pitch to their voice */
    float m_sentencePitch;
    float m_sentenceNext;
    int m_iFlags;
 
    entity m_useFollowChain;
    vector m_useLastAtPosition;
    float m_useFollowChangePathTime;
    float m_useFollowTraceTime;
    float m_useFollowSpeedChanged;
    float m_useFollowSpeed;
    bool m_bFollowOnUse;
 
    float m_flFollowDistance;
    float m_flMaxFollowDistance;
    bool m_bFollowGrouping;
 
    /* sentences identifiers */
    string m_talkAnswer; /* random answer to whenever a question is asked */
    string m_talkAsk; /* asks a random generic question */
    string m_talkAllyShot; /* asks to not shoot an ally further */
    string m_talkGreet; /* greet other NPCs */
    string m_talkIdle; /* idle chatter */
    string m_talkPanic; /* panic screams */
    string m_talkHearing; /* what did we just hear? */
    string m_talkSmelling; /* is something smelling bad? */
    string m_talkStare; /* when NPC is being stared at */
    string m_talkSurvived; /* we're near death */
    string m_talkWounded; /* we've sustained light wounds */
    string m_talkAlert; /* we've been alerted to a threat */
 
    /* things that NPCs will only say to the player */
    string m_talkPlayerAsk; /* ask player some question */
    string m_talkPlayerGreet; /* say hello to the player */
    string m_talkPlayerIdle; /* idle chatter with the player */
    string m_talkPlayerWounded1; /* slightly wounded player comment */
    string m_talkPlayerWounded2; /* a bit worse */
    string m_talkPlayerWounded3; /* yup, got thus far */
    string m_talkUnfollow; /* when the player asks us to stop following */
    string m_talkFollow; /* whenever player asks the NPC to follow */
    string m_talkStopFollow; /* we have to stop following */
    string m_talkDenyFollow; /* deny the follow request. */
 
    virtual void _Alerted(void);
#endif
 
#ifdef CLIENT
    /* sentence system */
    float m_flSentenceTime;
    sound_t *m_pSentenceQue;
    int m_iSentenceCount;
    int m_iSentencePos;
    float m_sndVoiceOffs;
    bool m_bWasPaused;
#endif
};
 
#ifdef CLIENT
void ncTalkMonster_ParseSentence(void);
void ncTalkMonster_ReadEntity(bool);
#endif