//========= Copyright Valve Corporation, All rights reserved. ============//

//

// Purpose: Console commands for debugging and manipulating NPCs.

//

//===========================================================================//

#include "cbase.h"

#include "ai_basenpc.h"

#include "player.h"

#include "entitylist.h"

#include "ai_network.h"

#include "ai_node.h"

#include "ai_link.h"

#include "ai_networkmanager.h"

#include "ndebugoverlay.h"

#include "datacache/imdlcache.h"

// memdbgon must be the last include file in a .cpp file!!!

#include "tier0/memdbgon.h"

extern CAI_Node* FindPickerAINode( CBasePlayer* pPlayer, NodeType_e nNodeType );

extern void SetDebugBits( CBasePlayer* pPlayer, const char *name, int bit );

extern CBaseEntity *FindPickerEntity( CBasePlayer *pPlayer );

extern bool g_bAIDisabledByUser;

//------------------------------------------------------------------------------

// Purpose: Disables all NPCs

//------------------------------------------------------------------------------

void CC_AI_Disable( void )

}

static ConCommand ai_disable("ai_disable", CC_AI_Disable, "Bi-passes all AI logic routines and puts all NPCs into their idle animations. Can be used to get NPCs out of your way and to test effect of AI logic routines on frame rate", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show hint nodes

//------------------------------------------------------------------------------

void CC_AI_ShowHints( void )

}

static ConCommand ai_show_hints("ai_show_hints", CC_AI_ShowHints, "Displays all hints as small boxes\n\tBlue - hint is available for use\n\tRed - hint is currently being used by an NPC\n\tOrange - hint not being used by timed out\n\tGrey - hint has been disabled", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show node connections with hulls

//------------------------------------------------------------------------------

void CC_AI_ShowHull( const CCommand &args )

}

static ConCommand ai_show_hull("ai_show_hull", CC_AI_ShowHull, "Displays the allowed hulls between each node for the currently selected hull type. Hulls are color code as follows:\n\tGreen - ground movement \n\tBlue - jumping movement\n\tCyan - flying movement\n\tMagenta - climbing movement\n\tArguments: -none-", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show node connections with lines

//------------------------------------------------------------------------------

void CC_AI_ShowConnect( const CCommand &args )

}

static ConCommand ai_show_connect("ai_show_connect", CC_AI_ShowConnect, "Displays the allowed connections between each node for the currently selected hull type. Hulls are color code as follows:\n\tGreen - ground movement \n\tBlue - jumping movement\n\tCyan - flying movement\n\tMagenta - climbing movement\n\tRed - connection disabled", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show node connections with lines

//------------------------------------------------------------------------------

void CC_AI_ShowJumpConnect( const CCommand &args )

}

static ConCommand ai_show_connect_jump("ai_show_connect_jump", CC_AI_ShowJumpConnect, "Displays the allowed connections between each node for the currently selected hull type. Hulls are color code as follows:\n\tGreen - ground movement \n\tBlue - jumping movement\n\tCyan - flying movement\n\tMagenta - climbing movement\n\tRed - connection disabled", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show node connections with lines

//------------------------------------------------------------------------------

void CC_AI_ShowFlyConnect( const CCommand &args )

}

static ConCommand ai_show_connect_fly("ai_show_connect_fly", CC_AI_ShowFlyConnect, "Displays the allowed connections between each node for the currently selected hull type. Hulls are color code as follows:\n\tGreen - ground movement \n\tBlue - jumping movement\n\tCyan - flying movement\n\tMagenta - climbing movement\n\tRed - connection disabled", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Draw a grid on the screen (good for laying down nodes)

//------------------------------------------------------------------------------

void CC_AI_ShowGrid( const CCommand &args )

}

static ConCommand ai_show_grid("ai_show_grid", CC_AI_ShowGrid, "Draw a grid on the floor where looking.", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: NPC step trough AI

//------------------------------------------------------------------------------

void CC_AI_Step( void )

}

static ConCommand ai_step("ai_step", CC_AI_Step, "NPCs will freeze after completing their current task. To complete the next task, use 'ai_step' again. To resume processing normally use 'ai_resume'", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Resume normal AI processing after stepping

//------------------------------------------------------------------------------

void CC_AI_Resume( void )

}

static ConCommand ai_resume("ai_resume", CC_AI_Resume, "If NPC is stepping through tasks (see ai_step ) will resume normal processing.", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Switch to display of next hull type

//------------------------------------------------------------------------------

void CC_AI_NextHull( const CCommand &args )

}

static ConCommand ai_next_hull("ai_next_hull", CC_AI_NextHull, "Cycles through the various hull sizes. Currently selected hull size is written to the screen. Controls which connections are shown when ai_show_hull or ai_show_connect commands are used\n\tArguments: -none-", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Display the hull type of the specified NPC.

//------------------------------------------------------------------------------

void CC_AI_Hull( const CCommand &args )

}

static ConCommand ai_hull("ai_hull", CC_AI_Hull, "Controls which connections are shown when ai_show_hull or ai_show_connect commands are used\n\tArguments: NPC name or classname, <none>=NPC under crosshair", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show AI nodes

//------------------------------------------------------------------------------

void CC_AI_Nodes( const CCommand &args )

}

static ConCommand ai_nodes("ai_nodes", CC_AI_Nodes, "Toggles node display. First call displays the nodes for the given network as green objects. Second call displays the nodes and their IDs. Nodes are color coded as follows:\n\tGreen - ground node\n\tCyan - air node\n\tMagenta - climb node\n\tGrey - node not available for selected hull size\n\tOrange - node currently locked", FCVAR_CHEAT);

CON_COMMAND(ai_show_node, "Highlight the specified node")

{

if ( args.ArgC() > 1 )

{

int node = atoi(args[1]);

CAI_Node* pAINode = g_pBigAINet->GetNode( node, false );

if ( pAINode )

{

NDebugOverlay::Cross3D(pAINode->GetOrigin(), 1024, 255, 255, 255, true, 5.0 );

}

}

}

//------------------------------------------------------------------------------

// Purpose: Show visibility from selected node to all other nodes

//------------------------------------------------------------------------------

void CC_AI_ShowVisibility( const CCommand &args )

}

static ConCommand ai_show_visibility("ai_show_visibility", CC_AI_ShowVisibility, "Toggles visibility display for the node that the player is looking at. Nodes that are visible from the selected node will be drawn in red with yellow lines connecting to the selected node. Nodes that are not visible from the selected node will be drawn in blue.", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show what nodes the selected node is connected to using the

// netowrk graph

//------------------------------------------------------------------------------

void CC_AI_GraphConnect( const CCommand &args )

}

static ConCommand ai_show_graph_connect("ai_show_graph_connect", CC_AI_GraphConnect, "Toggles graph connection display for the node that the player is looking at. Nodes that are connected to the selected node by the net graph will be drawn in red with magenta lines connecting to the selected node. Nodes that are not connected via the net graph from the selected node will be drawn in blue.", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show route triangulation attempts

//------------------------------------------------------------------------------

void CC_NPC_Bipass( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_TRIANGULATE_BIT);

}

static ConCommand npc_bipass("npc_bipass", CC_NPC_Bipass, "Displays the local movement attempts by the given NPC(s) (triangulation detours). Failed bypass routes are displayed in red, successful bypasses are shown in green.\n\tArguments: {entity_name} / {class_name} / no argument picks what player is looking at.", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Destroy selected NPC

//------------------------------------------------------------------------------

void CC_NPC_Destroy( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_ZAP_BIT);

}

static ConCommand npc_destroy("npc_destroy", CC_NPC_Destroy, "Removes the given NPC(s) from the universe\nArguments: {npc_name} / {npc_class_name} / no argument picks what player is looking at", FCVAR_CHEAT);

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

void CC_NPC_Kill( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_KILL_BIT);

}

static ConCommand npc_kill("npc_kill", CC_NPC_Kill, "Kills the given NPC(s)\nArguments: {npc_name} / {npc_class_name} / no argument picks what player is looking at", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show selected NPC's enemies

//------------------------------------------------------------------------------

void CC_NPC_Enemies( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_ENEMIES_BIT);

}

static ConCommand npc_enemies("npc_enemies", CC_NPC_Enemies, "Shows memory of NPC. Draws an X on top of each memory.\n\tEluded entities drawn in blue (don't know where it went)\n\tUnreachable entities drawn in green (can't get to it)\n\tCurrent enemy drawn in red\n\tCurrent target entity drawn in magenta\n\tAll other entities drawn in pink\n\tArguments: {npc_name} / {npc class_name} / no argument picks what player is looking at", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show seletected NPC's current enemy and target entity

//------------------------------------------------------------------------------

void CC_NPC_Focus( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_FOCUS_BIT);

}

static ConCommand npc_focus("npc_focus", CC_NPC_Focus, "Displays red line to NPC's enemy (if has one) and blue line to NPC's target entity (if has one)\n\tArguments: {npc_name} / {npc class_name} / no argument picks what player is looking at", FCVAR_CHEAT);

ConVar npc_create_equipment("npc_create_equipment", "");

//------------------------------------------------------------------------------

// Purpose: Create an NPC of the given type

//------------------------------------------------------------------------------

void CC_NPC_Create( const CCommand &args )

}

static ConCommand npc_create("npc_create", CC_NPC_Create, "Creates an NPC of the given type where the player is looking (if the given NPC can actually stand at that location). Note that this only works for npc classes that are already in the world. You can not create an entity that doesn't have an instance in the level.\n\tArguments: {npc_class_name}", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Create an NPC of the given type

//------------------------------------------------------------------------------

void CC_NPC_Create_Aimed( const CCommand &args )

}

static ConCommand npc_create_aimed("npc_create_aimed", CC_NPC_Create_Aimed, "Creates an NPC aimed away from the player of the given type where the player is looking (if the given NPC can actually stand at that location). Note that this only works for npc classes that are already in the world. You can not create an entity that doesn't have an instance in the level.\n\tArguments: {npc_class_name}", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Destroy unselected NPCs

//------------------------------------------------------------------------------

void CC_NPC_DestroyUnselected( void )

}

static ConCommand npc_destroy_unselected("npc_destroy_unselected", CC_NPC_DestroyUnselected, "Removes all NPCs from the universe that aren't currently selected", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Freeze or unfreeze the selected NPCs. If no NPCs are selected, the

// NPC under the crosshair is frozen/unfrozen.

//------------------------------------------------------------------------------

void CC_NPC_Freeze( const CCommand &args )

}

static ConCommand npc_freeze("npc_freeze", CC_NPC_Freeze, "Selected NPC(s) will freeze in place (or unfreeze). If there are no selected NPCs, uses the NPC under the crosshair.\n\tArguments: -none-", FCVAR_CHEAT);

CON_COMMAND( npc_freeze_unselected, "Freeze all NPCs not selected" )

{

CAI_BaseNPC *pNPC = gEntList.NextEntByClass( (CAI_BaseNPC *)NULL );

while (pNPC)

{

if (!(pNPC->m_debugOverlays & OVERLAY_NPC_SELECTED_BIT))

{

pNPC->ToggleFreeze();

}

pNPC = gEntList.NextEntByClass(pNPC);

}

}

//------------------------------------------------------------------------------

CON_COMMAND(npc_thinknow, "Trigger NPC to think")

{

if ( !UTIL_IsCommandIssuedByServerAdmin() )

return;

CBaseEntity *pEntity = FindPickerEntity( UTIL_GetCommandClient() );

if ( pEntity )

{

CAI_BaseNPC *pNPC = pEntity->MyNPCPointer();

if (pNPC)

{

pNPC->SetThink( &CAI_BaseNPC::CallNPCThink );

pNPC->SetNextThink( gpGlobals->curtime );

}

}

}

//------------------------------------------------------------------------------

// Purpose: Tell selected NPC to go to a where player is looking

//------------------------------------------------------------------------------

void CC_NPC_Teleport( void )

}

static ConCommand npc_teleport("npc_teleport", CC_NPC_Teleport, "Selected NPC will teleport to the location that the player is looking (shown with a purple box)\n\tArguments: -none-", FCVAR_CHEAT);

static ConVar npc_go_do_run( "npc_go_do_run", "1", 0, "Set whether should run on NPC go" );

void CC_NPC_Go( void )

}

static ConCommand npc_go("npc_go", CC_NPC_Go, "Selected NPC(s) will go to the location that the player is looking (shown with a purple box)\n\tArguments: -none-", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Tell seclected NPC to go to a random node location

//------------------------------------------------------------------------------

void CC_NPC_GoRandom( void )

{

CAI_BaseNPC::ForceSelectedGoRandom();

}

static ConCommand npc_go_random("npc_go_random", CC_NPC_GoRandom, "Sends all selected NPC(s) to a random node.\n\tArguments: -none-", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: ?Does this work?

//------------------------------------------------------------------------------

void CC_NPC_Reset( void )

}

static ConCommand npc_reset("npc_reset", CC_NPC_Reset, "Reloads schedules for all NPC's from their script files\n\tArguments: -none-", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show the selected NPC's nearest node

//------------------------------------------------------------------------------

void CC_NPC_Nearest( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_NEAREST_BIT);

}

static ConCommand npc_nearest("npc_nearest", CC_NPC_Nearest, "Draw's a while box around the NPC(s) nearest node\n\tArguments: {entity_name} / {class_name} / no argument picks what player is looking at ", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show the selected NPC's route

//------------------------------------------------------------------------------

void CC_NPC_Route( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_ROUTE_BIT);

}

static ConCommand npc_route("npc_route", CC_NPC_Route, "Displays the current route of the given NPC as a line on the screen. Waypoints along the route are drawn as small cyan rectangles. Line is color coded in the following manner:\n\tBlue - path to a node\n\tCyan - detour around an object (triangulation)\n\tRed - jump\n\tMaroon - path to final target position\n\tArguments: {npc_name} / {npc_class_name} / no argument picks what player is looking at ", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Select an NPC

//------------------------------------------------------------------------------

void CC_NPC_Select( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_SELECTED_BIT);

}

static ConCommand npc_select("npc_select", CC_NPC_Select, "Select or deselects the given NPC(s) for later manipulation. Selected NPC's are shown surrounded by a red translucent box\n\tArguments: {entity_name} / {class_name} / no argument picks what player is looking at ", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show combat related data for an NPC

//------------------------------------------------------------------------------

void CC_NPC_Combat( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_SQUAD_BIT);

}

static ConCommand npc_combat("npc_combat", CC_NPC_Combat, "Displays text debugging information about the squad and enemy of the selected NPC (See Overlay Text)\n\tArguments: {npc_name} / {npc class_name} / no argument picks what player is looking at", FCVAR_CHEAT);

// For backwards compatibility

static ConCommand npc_squads("npc_squads", CC_NPC_Combat, "Obsolete. Replaced by npc_combat", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show tasks for an NPC

//------------------------------------------------------------------------------

void CC_NPC_Tasks( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_TASK_BIT);

}

static ConCommand npc_tasks("npc_tasks", CC_NPC_Tasks, "Displays detailed text debugging information about the all the tasks of the selected NPC current schedule (See Overlay Text)\n\tArguments: {npc_name} / {npc class_name} / no argument picks what player is looking at ", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show tasks (on the console) for an NPC

//------------------------------------------------------------------------------

void CC_NPC_Task_Text( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(), args[1], OVERLAY_TASK_TEXT_BIT);

}

static ConCommand npc_task_text("npc_task_text", CC_NPC_Task_Text, "Outputs text debugging information to the console about the all the tasks + break conditions of the selected NPC current schedule\n\tArguments: {npc_name} / {npc class_name} / no argument picks what player is looking at ", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Shows all current conditions for an NPC.

//------------------------------------------------------------------------------

void CC_NPC_Conditions( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(), args[1], OVERLAY_NPC_CONDITIONS_BIT);

}

static ConCommand npc_conditions("npc_conditions", CC_NPC_Conditions, "Displays all the current AI conditions that an NPC has in the overlay text.\n\tArguments: {npc_name} / {npc class_name} / no argument picks what player is looking at", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show an NPC's viewcone

//------------------------------------------------------------------------------

void CC_NPC_Viewcone( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1],OVERLAY_NPC_VIEWCONE_BIT);

}

static ConCommand npc_viewcone("npc_viewcone", CC_NPC_Viewcone, "Displays the viewcone of the NPC (where they are currently looking and what the extents of there vision is)\n\tArguments: {entity_name} / {class_name} / no argument picks what player is looking at", FCVAR_CHEAT);

//------------------------------------------------------------------------------

// Purpose: Show an NPC's relationships to other NPCs

//------------------------------------------------------------------------------

void CC_NPC_Relationships( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(),args[1], OVERLAY_NPC_RELATION_BIT );

}

static ConCommand npc_relationships("npc_relationships", CC_NPC_Relationships, "Displays the relationships between this NPC and all others.\n\tArguments: {entity_name} / {class_name} / no argument picks what player is looking at", FCVAR_CHEAT );

//------------------------------------------------------------------------------

// Purpose: Show an NPC's steering regulations

//------------------------------------------------------------------------------

void CC_NPC_ViewSteeringRegulations( const CCommand &args )

{

SetDebugBits( UTIL_GetCommandClient(), args[1], OVERLAY_NPC_STEERING_REGULATIONS);

}

static ConCommand npc_steering("npc_steering", CC_NPC_ViewSteeringRegulations, "Displays the steering obstructions of the NPC (used to perform local avoidance)\n\tArguments: {entity_name} / {class_name} / no argument picks what player is looking at", FCVAR_CHEAT);

void CC_NPC_ViewSteeringRegulationsAll( void )

}

static ConCommand npc_steering_all("npc_steering_all", CC_NPC_ViewSteeringRegulationsAll, "Displays the steering obstructions of all NPCs (used to perform local avoidance)\n", FCVAR_CHEAT);

//------------------------------------------------------------------------------

CON_COMMAND( npc_heal, "Heals the target back to full health" )

{

if ( !UTIL_IsCommandIssuedByServerAdmin() )

return;

CBaseEntity *pEntity = FindPickerEntity( UTIL_GetCommandClient() );

if ( pEntity )

{

CAI_BaseNPC *pNPC = pEntity->MyNPCPointer();

if (pNPC)

{

pNPC->SetHealth( pNPC->GetMaxHealth() );

}

}

}

CON_COMMAND( npc_ammo_deplete, "Subtracts half of the target's ammo" )

{

if ( !UTIL_IsCommandIssuedByServerAdmin() )

return;

CBaseEntity *pEntity = FindPickerEntity( UTIL_GetCommandClient() );

if ( pEntity )

{

CAI_BaseNPC *pNPC = pEntity->MyNPCPointer();

if (pNPC && pNPC->GetActiveWeapon())

{

pNPC->GetActiveWeapon()->m_iClip1 *= 0.5;

}

}

}

CON_COMMAND( ai_clear_bad_links, "Clears bits set on nav links indicating link is unusable " )

{

if ( !UTIL_IsCommandIssuedByServerAdmin() )

return;

CAI_Node *pNode;

for ( int i = 0; i < g_pBigAINet->NumNodes(); i++ )

{

pNode = g_pBigAINet->GetNode( i );

for ( int j = 0; j < pNode->NumLinks(); j++ )

{

pNode->GetLinkByIndex( j )->m_LinkInfo &= ~bits_LINK_STALE_SUGGESTED;

}

}

}

CON_COMMAND( ai_test_los, "Test AI LOS from the player's POV" )

{

if ( !UTIL_IsCommandIssuedByServerAdmin() )

return;

trace_t tr;

// Use the custom LOS trace filter

CTraceFilterLOS traceFilter( UTIL_GetLocalPlayer(), COLLISION_GROUP_NONE );

UTIL_TraceLine( UTIL_GetLocalPlayer()->EyePosition(), UTIL_GetLocalPlayer()->EyePosition() + UTIL_GetLocalPlayer()->EyeDirection3D() * MAX_COORD_RANGE, MASK_BLOCKLOS_AND_NPCS, &traceFilter, &tr );

NDebugOverlay::Line( UTIL_GetLocalPlayer()->EyePosition(), tr.endpos, 127, 127, 127, true, 5 );

NDebugOverlay::Cross3D( tr.endpos, 24, 255, 255, 255, true, 5 );

}

#ifdef VPROF_ENABLED

CON_COMMAND(ainet_generate_report, "Generate a report to the console.")

{

g_VProfCurrentProfile.OutputReport( VPRT_FULL, "AINet" );

}

CON_COMMAND(ainet_generate_report_only, "Generate a report to the console.")

{

g_VProfCurrentProfile.OutputReport( VPRT_FULL, "AINet", g_VProfCurrentProfile.BudgetGroupNameToBudgetGroupID( "AINet" ) );

}

#endif