/***************************************************************************** The Dark Mod GPL Source Code This file is part of the The Dark Mod Source Code, originally based on the Doom 3 GPL Source Code as published in 2011. The Dark Mod Source Code is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. For details, see LICENSE.TXT. Project: The Dark Mod (http://www.thedarkmod.com/) ******************************************************************************/ #ifndef __AI_MEMORY_H__ #define __AI_MEMORY_H__ //#include "precompiled.h" #include "../BinaryFrobMover.h" #include "../FrobDoor.h" #include "DoorInfo.h" #include "AI.h" namespace ai { #define AIUSE_BLOOD_EVIDENCE "AIUSE_BLOOD_EVIDENCE" #define AIUSE_BROKEN_ITEM "AIUSE_BROKEN_ITEM" #define AIUSE_CARRY "AIUSE_CARRY" // for specific animations #define AIUSE_CATTLE "AIUSE_CATTLE" #define AIUSE_COOK "AIUSE_COOK" #define AIUSE_DRINK "AIUSE_DRINK" #define AIUSE_DOOR "AIUSE_DOOR" #define AIUSE_ELEVATOR "AIUSE_ELEVATOR" #define AIUSE_EAT "AIUSE_EAT" #define AIUSE_KEY "AIUSE_KEY" // Tels: for specific animations #define AIUSE_LIGHTSOURCE "AIUSE_LIGHTSOURCE" #define AIUSE_MISSING_ITEM_MARKER "AIUSE_MISSING_ITEM_MARKER" #define AIUSE_MONSTER "AIUSE_MONSTER" // a random or caged monster, not a pet #define AIUSE_PERSON "AIUSE_PERSON" #define AIUSE_PEST "AIUSE_PEST" #define AIUSE_PET "AIUSE_PET" #define AIUSE_READ "AIUSE_READ" // Tels: for specific animations #define AIUSE_SEAT "AIUSE_SEAT" #define AIUSE_STEAMBOT "AIUSE_STEAMBOT" // steambots #define AIUSE_UNDEAD "AIUSE_UNDEAD" // An undead creature #define AIUSE_WEAPON "AIUSE_WEAPON" #define AIUSE_SUSPICIOUS "AIUSE_SUSPICIOUS" // grayman #1327 #define AIUSE_ROPE "AIUSE_ROPE" // grayman #2872 #define AIUSE_ANIMAL "AIUSE_ANIMAL" // grayman #3331 //---------------------------------------------------------------------------------------- // The following key and values are used for identifying types of lights #define AIUSE_LIGHTTYPE_KEY "lightType" #define AIUSE_LIGHTTYPE_TORCH "AIUSE_LIGHTTYPE_TORCH" #define AIUSE_LIGHTTYPE_GASLAMP "AIUSE_LIGHTTYPE_GASLAMP" #define AIUSE_LIGHTTYPE_ELECTRIC "AIUSE_LIGHTTYPE_ELECTRIC" #define AIUSE_LIGHTTYPE_MAGIC "AIUSE_LIGHTTYPE_MAGIC" #define AIUSE_LIGHTTYPE_AMBIENT "AIUSE_LIGHTTYPE_AMBIENT" //---------------------------------------------------------------------------------------- // The following key is used to identify the name of the switch entity used to turn on // a AIUSE_LIGHTTYPE_ELECTRIC light. // grayman #2603 - not in use; switches are found at map start #define AIUSE_LIGHTSWITCH_NAME_KEY "switchName" //---------------------------------------------------------------------------------------- // The following defines the response type when a light is off #define AIUSE_SHOULDBEON_LEVEL "shouldBeOn" // grayman #2603 // SZ: Minimum count evidence of intruders to turn on all lights encountered // grayman #2603 - this is no longer used #define MIN_EVIDENCE_OF_INTRUDERS_TO_TURN_ON_ALL_LIGHTS 5 // angua: The AI starts searching after encountering a switched off light // only if it is already suspicious #define MIN_EVIDENCE_OF_INTRUDERS_TO_SEARCH_ON_LIGHT_OFF 3 // SZ: Minimum count of evidence of intruders to communicate suspicion to others #define MIN_EVIDENCE_OF_INTRUDERS_TO_COMMUNICATE_SUSPICION 3 // SZ: Someone hearing a distress call won't bother to shout that they are coming to their assistance unless // it is at least this far away. This is to simulate more natural human behavior. #define MIN_DISTANCE_TO_ISSUER_TO_SHOUT_COMING_TO_ASSISTANCE 200 // Considered cause radius around a tactile event //#define TACTILE_ALERT_RADIUS 10.0f // grayman #3857 - no longer used #define TACTILE_SEARCH_VOLUME idVec3(150,150,100) // grayman #2816 - was (40,40,40) which makes them stand still // Considered cause radius around a visual event //#define VISUAL_ALERT_RADIUS 25.0f // grayman #3857 - no longer used #define VISUAL_SEARCH_VOLUME idVec3(100,100,100) // Considered cause radius around an audio event //#define AUDIO_ALERT_RADIUS 50.0f // grayman #3857 - no longer used #define AUDIO_ALERT_FUZZINESS 100.0f #define AUDIO_SEARCH_VOLUME idVec3(300,300,200) #define ENEMY_DEAD_BARK_DELAY 1500 // grayman #2816 // Area searched around last sighting after losing an enemy //#define LOST_ENEMY_ALERT_RADIUS 200.0 // grayman #3857 - no longer used #define LOST_ENEMY_SEARCH_VOLUME idVec3(300, 300, 100) // grayman #3857 - was (200,200,100) //#define LOST_ENEMY_SEARCH_VOLUME idVec3(200, 200, 100) // grayman #2603 - was (200,200,200) // grayman #3424 - increase in evidence count per event type #define EVIDENCE_COUNT_INCREASE_ENEMY 3 // grayman #3515 - was 1 #define EVIDENCE_COUNT_INCREASE_CORPSE 3 #define EVIDENCE_COUNT_INCREASE_MISSING_ITEM 1 #define EVIDENCE_COUNT_INCREASE_FAILED_KO 1 #define EVIDENCE_COUNT_INCREASE_VIS_ALERT 1 #define EVIDENCE_COUNT_INCREASE_WEAPON 2 #define EVIDENCE_COUNT_INCREASE_SUSPICIOUS 1 #define EVIDENCE_COUNT_INCREASE_ROPE 1 #define EVIDENCE_COUNT_INCREASE_UNCONSCIOUS 1 #define EVIDENCE_COUNT_INCREASE_BLOOD 1 #define EVIDENCE_COUNT_INCREASE_LIGHT 1 #define EVIDENCE_COUNT_INCREASE_BROKEN_ITEM 1 #define EVIDENCE_COUNT_INCREASE_DOOR 1 enum EAlertClass { EAlertNone, EAlertVisual_1, EAlertVisual_2, // grayman #2603 //EAlertVisual_3, // grayman #3424, grayman #3472 - no longer needed EAlertVisual_4, // grayman #3498 - latched visual alert EAlertTactile, EAlertAudio, EAlertClassCount }; enum EAlertType { EAlertTypeNone, EAlertTypeSuspicious, EAlertTypeSuspiciousVisual, // grayman #3857 EAlertTypeEnemy, EAlertTypeFailedKO, // grayman #3857 EAlertTypeWeapon, EAlertTypeBlinded, // grayman #3857 EAlertTypeDeadPerson, EAlertTypeUnconsciousPerson, EAlertTypeBlood, EAlertTypeLightSource, EAlertTypeMissingItem, EAlertTypeBrokenItem, EAlertTypeDoor, EAlertTypeSuspiciousItem, // grayman #1327 EAlertTypeRope, // grayman #2872 EAlertTypeHitByProjectile, // grayman #3331 EAlertTypeFoundEnemy, // grayman #3857 EAlertTypeLostTrackOfEnemy, // grayman #3857 EAlertTypeEncounter, // grayman #3857 EAlertTypeRequestForHelp, // grayman #3857 EAlertTypeDetectedEnemy, // grayman #3857 EAlertTypeSomethingSuspicious, // grayman #3857 EAlertTypeHitByMoveable, // grayman #3857 - was EAlertTypeSuspicious EAlertTypePickedPocket, // grayman #3857 EAlertTypeCount }; // The alert index the AI is in enum EAlertState { ERelaxed = 0, EObservant, ESuspicious, ESearching, EAgitatedSearching, ECombat, EAlertStateNum }; // grayman #3140 - what caused my pain? enum EPainCause { EPC_None = 0, EPC_Projectile, EPC_Melee, EPC_Drown, EPC_KO, EPC_Fall, EPC_Moveable, EPC_Num }; // grayman #3857 - repeated bark states when in Agitated Searching enum ERepeatedBarkState { ERBS_NULL, // state not determined yet ERBS_SEARCHER_SINGLE_NO_EVIDENCE, // single searcher, hasn't seen any evidence of intruders ERBS_SEARCHER_MULTIPLE_NO_EVIDENCE, // multiple searchers, hasn't seen any evidence of intruders ERBS_SEARCHER_SINGLE_EVIDENCE, // single searcher, has seen evidence of intruders ERBS_SEARCHER_MULTIPLE_EVIDENCE, // multiple searchers, has seen evidence of intruders ERBS_GUARD_OBSERVER, // a guard or observer, has or hasn't seen evidence of intruders ERBS_NUM }; const char* const AlertStateNames[EAlertStateNum] = { "Relaxed", "Observant", "Suspicious", "Investigating", "AgitatedSearching", "Combat" }; #define MINIMUM_SECONDS_BETWEEN_STIMULUS_BARKS 15000 // milliseconds #define MINIMUM_SECONDS_BEFORE_CORPSE_BARK 5000 // milliseconds grayman #3848 #define MINIMUM_TIME_BETWEEN_WARNINGS (3*60) // grayman #3424 - seconds #define VARIABLE_TIME_BETWEEN_WARNINGS 60 // grayman #3424 - seconds #define DELAY_BETWEEN_WARNING_FAILURES 3 // grayman #3424 - seconds // SZ: Maximum amount of time since last visual or audio contact with a friendly person to use // group stimulous barks, in seconds #define MAX_FRIEND_SIGHTING_SECONDS_FOR_ACCOMPANIED_ALERT_BARK 5.0f // grayman - was 10.0f // TODO: Parameterize these as darkmod globals #define HIDING_OBJECT_HEIGHT 0.35f #define MAX_SPOTS_PER_SEARCH_CALL 100 // The maximum time the AI is able to follow the enemy during combat, although it's invisible (ms) #define MAX_BLIND_CHASE_TIME 3000 // The maximum time the AI is able to follow the enemy when it's unreachable, although it's invisible (ms) #define MAX_BLIND_UNREACHABLE_TIME 5000 // grayman #4343 (was 3000) // grayman #2603 - how long to wait until barking again about a light that's out (ms) #define REBARK_DELAY 15000 // grayman #3496 - how long to wait after an alert bark or visual stim bark before issuing the next alert bark (ms) #define MIN_TIME_BETWEEN_ALERT_BARKS 3000 const int MINIMUM_TIME_BETWEEN_GREETING_SAME_ACTOR = 4*60; // grayman #3415 - 4 minutes const int EXTRA_DELAY_BETWEEN_GREETING_SAME_ACTOR = 3*60; // grayman #3415 - random 0->3 min added to base minutes /** * greebo: This class acts as container for all kinds of state variables. */ class Memory { public: // The owning AI idAI* owner; // The path entity we're supposed to be heading to idEntityPtr currentPath; // Our next path entity idEntityPtr nextPath; // Our last path_corner entity idEntityPtr lastPath; // The game time, the AlertLevel was last increased. int lastAlertRiseTime; // Time in msecs to pass before alert level starts decreasing int deadTimeAfterAlertRise; // The last time the AI has been barking when patrolling int lastPatrolChatTime; int lastTimeFriendlyAISeen; // This is the last time the enemy was visible int lastTimeEnemySeen; // The last time a visual stim made the AI bark int lastTimeVisualStimBark; // grayman #3496 - the last time a rising alert bark was issued int lastTimeAlertBark; // grayman #3496 - whether the AI has recently spent time in Agitated Search. // Set to TRUE when in Agitated Search. Set to FALSE when dropping out of // Searching State. Also set to FALSE when entering Idle or Alert Idle. bool agitatedSearched; // grayman #3515 - whether you might have seen the player, and registered // a bump in your evidence count when you rose into Searching state bool mightHaveSeenPlayer; // grayman #2603 - The next time a light stim can make the AI bark int nextTimeLightStimBark; /*! * This variable indicates the number of out of place things that the * AI has witness, such as sounds, missing items, open doors, torches gone * out etc.. */ int countEvidenceOfIntruders; // Random head turning int nextHeadTurnCheckTime; bool currentlyHeadTurning; bool currentlyBarking; // grayman #3182 int headTurnEndTime; idVec3 idlePosition; idVec3 returnSitPosition; // grayman #3989 float idleYaw; // angua: whether the AI should play idle animations bool playIdleAnimations; // TRUE if enemies have been seen bool enemiesHaveBeenSeen; // TRUE if the enemy has shot/hurt/attempted blackjacking bool hasBeenAttackedByEnemy; // TRUE if the AI knows that items have been stolen bool itemsHaveBeenStolen; // TRUE if the AI has found something broken bool itemsHaveBeenBroken; // TRUE if the AI has found a dead or unconscious person bool unconsciousPeopleHaveBeenFound; bool deadPeopleHaveBeenFound; // grayman #3424 - did the AI see evidence the previous think frame? //bool prevSawEvidence; // grayman #3857 // grayman #3528 - TRUE if sitting or sleeping when dropping out of Observant bool stayPut; // position of alert causing stimulus idVec3 alertPos; // grayman #2903 - positions of AI when there's an alert that can lead to warnings between AI idVec3 posEnemySeen; idVec3 posMissingItem; idVec3 posEvidenceIntruders; // grayman #3140 - cause of pain EPainCause causeOfPain; // grayman #3424 - only push one pain state per frame bool painStatePushedThisFrame; // grayman #3331 - force a hiding spot search (don't rely just on the alert index changing) bool mandatory; // grayman #3857 - whether we're responding to a DetectedSomethingSuspicious_CommType message or not bool respondingToSomethingSuspiciousMsg; // grayman #2903 - timestamps of alerts that can lead to warnings between AI int timeEvidenceIntruders; idEntityPtr corpseFound; // grayman #3424 idEntityPtr unconsciousPersonFound; // grayman #3857 // grayman #2422 - alert level is rising by checking player visibility // grayman #3857 - no longer used //bool visualAlert; // grayman #2603 - abort an ongoing light relight? bool stopRelight; // grayman #2872 - abort a rope examination? bool stopExaminingRope; // grayman #2816 - abort looking at a moveable that hit you bool stopReactingToHit; // grayman #3559 - abort your reaction to having something stolen from you bool stopReactingToPickedPocket; // grayman #3559 - latch a picked pocket reaction until done with what you're doing bool latchPickedPocket; // grayman #3559 - whether a picked pocket was near an alert bool insideAlertWindow; // grayman #2816 - abort door handling bool stopHandlingDoor; // grayman #2816 - abort elevator handling bool stopHandlingElevator; // grayman #2422 - next time to generate a random search spot int nextTime2GenRandomSpot; // grayman #2603 - a light that's being relit idEntityPtr relightLight; // Type of alert (visual, tactile, audio) EAlertClass alertClass; // Source of the alert (enemy, weapon, blood, dead person, etc.) EAlertType alertType; // radius of alert causing stimulus (depends on the type and distance) //float alertRadius; // grayman #3857 - no longer used // The last time we had an incoming audio alert int lastAudioAlertTime; // This is true if the original alert position is to be searched bool stimulusLocationItselfShouldBeSearched; // Set this to TRUE if stimulus location itself should be closely investigated (kneel down) bool investigateStimulusLocationClosely; // This flag indicates if the last alert is due to a communication message bool alertedDueToCommunication; // Position of the last alert causing stimulus which was searched. // This is used to compare new stimuli to the previous stimuli searched // to determine if a new search is necessary // grayman #3075 - this wasn't being used, and was causing errors because it was always (0,0,0) // grayman #3492 - reinstate this idVec3 lastAlertPosSearched; // greebo: This is the position of the alert that was used to set up a hiding spot search. idVec3 alertSearchCenter; // A search area vector that is m_alertRadius on each side idVec3 alertSearchVolume; // An area within the search volume that is to be ignored. It is used for expanding // radius searches that don't re-search the inner points. idVec3 alertSearchExclusionVolume; // The last position the enemy was seen // greebo: Note: Currently this is filled in before fleeing only. idVec3 lastEnemyPos; // This is set to TRUE by the sensory routines to indicate whether // the AI is in the position to damage the player. // This flag is mostly for caching purposes so that the subsystem tasks // don't need to query idAI::CanHitEnemy() independently. bool canHitEnemy; // ishtvan: Whether we will be able to hit the enemy in the future if we // start a melee attack right now. // If the AI checks this, the CanHitEnemy query sets it as well as canHitEnemy bool willBeAbleToHitEnemy; /** * When true, an enemy can potentially hit us with a melee attack in the near future **/ bool canBeHitByEnemy; /*! * These hold the current spot search target, regardless of whether * or not it is a hiding spot search or some other sort of spot search */ idVec3 currentSearchSpot; /*! * This flag indicates if a hiding spot test was started * @author SophisticatedZombie */ bool hidingSpotTestStarted; /*! * This flag idnicates if a hiding spot was chosen */ bool hidingSpotSearchDone; /** * greebo: TRUE if a hiding spot search has been started and * the AI has searched all of them already. */ bool noMoreHidingSpots; /** * greebo: This is queried by the SearchStates and indicates a new * stimulus to be considered. */ bool restartSearchForHidingSpots; // This counts the number of frames we have been thinking, in case // we have a problem with hiding spot searches not returning int hidingSpotThinkFrameCount; //int firstChosenHidingSpotIndex; // grayman #3857 //int currentChosenHidingSpotIndex; // grayman #3857 //idVec3 chosenHidingSpot; // grayman #3857 // True if the AI is currently investigating a hiding spot (walking to it, for instance). bool hidingSpotInvestigationInProgress; // grayman #3857 - true if the AI is currently guarding or observing a location while // participating in a search bool guardingInProgress; // grayman #3857 - true if the AI is currently milling about the alert spot bool millingInProgress; // grayman #3857 - true if the AI needs to stop doing one of the above tasks bool stopHidingSpotInvestigation; bool stopGuarding; bool stopMilling; // grayman #3857 - true if the AI should mill about the alert spot // before running to a guard or observation spot bool shouldMill; // grayman #3857 - when guarding a spot, face this angle (yaw) float guardingAngle; // grayman #3857 - consecutive failed attempts to find a milling or observing spot int consecutiveRadialSpotFailures; ERepeatedBarkState repeatedBarkState; // grayman #3857 // True if fleeing bool fleeing; // angua: The last position of the AI before it takes cover, so it can return to it later. idVec3 positionBeforeTakingCover; // TRUE when the AI is currently trying to resolve a block bool resolvingMovementBlock; // grayman #2712 - last door handled idEntityPtr lastDoorHandled; // grayman #2816 - moveable that hit the AI idEntityPtr hitByThisMoveable; // grayman #3052 - need to move to the idle map start spot before performing a PathWaitForTrigger task bool issueMoveToPositionTask; // grayman #2866 - start of changes idEntityPtr closeMe; // a door that should be closed idEntityPtr frontPos; // the door handling position closest to the AI idEntityPtr backPos; // the door handling position closest to the AI bool closeSuspiciousDoor; // need to close a suspicious door bool doorSwingsToward; // does the door swing toward me? bool closeFromAwayPos; // do we close a suspicious door from the near side or far side? int susDoorCloseFromThisSide; // grayman #3643 - door side we're on when spotting it bool susDoorSameAsCurrentDoor; // the door you're handling sends you a visual stim int blockedDoorCount; // grayman #4830 float savedAlertLevelDecreaseRate; // used w/door handling in Observant state // end of #2866 changes int currentSearchEventID; // grayman #3424 - current suspicious event being searched int searchStartTime; // grayman #4220 - when this AI begins a search idEntityPtr attacker; // grayman #3679 - who attacked me bool playerResponsible; // grayman #3679 - is the player responsible for the attack? int combatState; // grayman #3507 - use when returning to Combat bool leaveAlertState; // grayman #3857 // Maps doors to info structures typedef std::map DoorInfoMap; // This maps AAS area numbers to door info structures typedef std::map AreaToDoorInfoMap; // Variables related to door opening/closing process struct DoorRelatedVariables { // The door we're currently handling (e.g. during HandleDoorTask) idEntityPtr currentDoor; // This maps CFrobDoor* pointers to door info structures DoorInfoMap doorInfo; // This allows for quick lookup of info structures via area number AreaToDoorInfoMap areaDoorInfoMap; } doorRelated; struct GreetingInfo { // The next time an associated AI can be greeted by the owner int nextGreetingTime; // grayman #3415 // The next time an associated AI can receive a warning from the owner int nextWarningTime; // grayman #3424 GreetingInfo() : nextGreetingTime(gameLocal.random.RandomInt(MINIMUM_TIME_BETWEEN_GREETING_SAME_ACTOR)*1000), // grayman #3415 nextWarningTime(0) // grayman #3424 {} }; typedef std::map ActorGreetingInfoMap; ActorGreetingInfoMap greetingInfo; // Pass the owning AI to the constructor Memory(idAI* owningAI); // Save/Restore routines void Save(idSaveGame* savefile) const; void Restore(idRestoreGame* savefile); /** * greebo: Returns the door info structure for the given door. * This will create a new info structure if it doesn't exist yet, so the reference is always valid. */ DoorInfo& GetDoorInfo(CFrobDoor* door); // Similar to above, but use the area number as input argument, can return NULL DoorInfoPtr GetDoorInfo(int areaNum); // Returns the greeting info structure for the given actor GreetingInfo& GetGreetingInfo(idActor* actor); // grayman #3559 - stops state reactions void StopReacting(); }; } // namespace ai #endif /*__AI_MEMORY_H__*/