RingRacers/src/k_bot.h

// SONIC ROBO BLAST 2 KART
//-----------------------------------------------------------------------------
// Copyright (C) 2018-2020 by Sally "TehRealSalt" Cochenour
// Copyright (C) 2018-2020 by Kart Krew
//
// This program is free software distributed under the
// terms of the GNU General Public License, version 2.
// See the 'LICENSE' file for more details.
//-----------------------------------------------------------------------------
/// \file  k_bot.h
/// \brief Bot logic & ticcmd generation code

#ifndef __K_BOT__
#define __K_BOT__

#include "k_waypoint.h"
#include "d_player.h"
#include "r_defs.h"

// Maximum value of botvars.difficulty
#define MAXBOTDIFFICULTY 13

// Level of a "difficult" bot. The max bot level was increased, but this keeps all of the same calculations.
#define DIFFICULTBOT 9

// How many tics in a row do you need to turn in this direction before we'll let you turn.
// Made it as small as possible without making it look like the bots are twitching constantly.
#define BOTTURNCONFIRM 4

// How many tics without being able to accelerate before we'll let you spindash.
#define BOTSPINDASHCONFIRM (2*TICRATE)

// Point for bots to aim for
typedef struct botprediction_s {
	fixed_t x, y;
	fixed_t radius;
} botprediction_t;


// AVAILABLE FOR LUA


/*--------------------------------------------------
	boolean K_PlayerUsesBotMovement(player_t *player);

		Tells if this player is being controlled via bot movement code (is a bot, or is exiting).

	Input Arguments:-
		player - Player to check.

	Return:-
		true if using bot movement code, otherwise false.
--------------------------------------------------*/

boolean K_PlayerUsesBotMovement(player_t *player);


/*--------------------------------------------------
	boolean K_BotCanTakeCut(player_t *player);

		Tells if this bot is able to take shortcuts (currently unaffected by offroad,
		or has certain items ready).

	Input Arguments:-
		player - Player to check.

	Return:-
		true if able to take shortcuts, otherwise false.
--------------------------------------------------*/

boolean K_BotCanTakeCut(player_t *player);


/*--------------------------------------------------
	fixed_t K_BotRubberband(player_t *player);

		Gives a multiplier for a bot's rubberbanding.
		Meant to be used for acceleration and handling.

	Input Arguments:-
		player - Player to check.

	Return:-
		A multiplier in fixed point scale.
--------------------------------------------------*/

fixed_t K_BotRubberband(player_t *player);


/*--------------------------------------------------
	fixed_t K_UpdateRubberband(player_t *player);

		Eases the current rubberbanding value to the
		new one, calculated by K_BotRubberband.

	Input Arguments:-
		player - Player to update.

	Return:-
		The new rubberband multiplier, in fixed point scale.
--------------------------------------------------*/

fixed_t K_UpdateRubberband(player_t *player);


/*--------------------------------------------------
	fixed_t K_DistanceOfLineFromPoint(fixed_t v1x, fixed_t v1y, fixed_t v2x, fixed_t v2y, fixed_t cx, fixed_t cy);

		Gets the distance of a point away from a line.
		TODO: Could go in another file?

	Input Arguments:-
		v1x - Line's first vertex x position.
		v1y - Line's first vertex y position.
		v2x - Line's second vertex x position.
		v2y - Line's second vertex y position.
		cx - Point's x position.
		cy - Point's y position.

	Return:-
		The distance between the point and the line.
--------------------------------------------------*/

fixed_t K_DistanceOfLineFromPoint(fixed_t v1x, fixed_t v1y, fixed_t v2x, fixed_t v2y, fixed_t cx, fixed_t cy);


// NOT AVAILABLE FOR LUA


/*--------------------------------------------------
	boolean K_AddBot(UINT8 skin, UINT8 difficulty, UINT8 *newplayernum);

		Returns the waypoint actually being used as the finish line.

	Input Arguments:-
		skin - Skin number that the bot will use.
		difficulty - Difficulty level this bot will use.
		newplayernum - Pointer to the last valid player slot number.
			Is a pointer so that this function can be called multiple times to add more than one bot.

	Return:-
		true if a bot packet can be sent, otherwise false.
--------------------------------------------------*/

boolean K_AddBot(UINT8 skin, UINT8 difficulty, UINT8 *newplayernum);


/*--------------------------------------------------
	void K_UpdateMatchRaceBots(void);

		Updates the number of bots in the server and their difficulties for Match Race.
--------------------------------------------------*/

void K_UpdateMatchRaceBots(void);


/*--------------------------------------------------
	UINT8 K_EggboxStealth(fixed_t x, fixed_t y);

		Gets a "stealth" value for a position, to figure out how
		well Eggman boxes blend into random items.

	Input Arguments:-
		x - X coordinate to check.
		y - Y coordinate to check.

	Return:-
		Stealth value for the position.
--------------------------------------------------*/

UINT8 K_EggboxStealth(fixed_t x, fixed_t y);


/*--------------------------------------------------
	boolean K_BotHatesThisSector(player_t *player, sector_t *sec, fixed_t x, fixed_t y)

		Tells us if a bot will play more careful around
		this sector. Checks FOFs in the sector, as well.

	Input Arguments:-
		player - Player to check against.
		sec - Sector to check against.
		x - Linedef cross X position, for slopes
		y - Linedef cross Y position, for slopes

	Return:-
		true if avoiding this sector, false otherwise.
--------------------------------------------------*/

boolean K_BotHatesThisSector(player_t *player, sector_t *sec, fixed_t x, fixed_t y);


/*--------------------------------------------------
	void K_NudgePredictionTowardsObjects(botprediction_t *predict, player_t *player);

		Moves the bot's prediction, based on objects around the bot.

	Input Arguments:-
		predict - The bot's prediction to nudge.
		player - Player to compare.

	Return:-
		None
--------------------------------------------------*/

void K_NudgePredictionTowardsObjects(botprediction_t *predict, player_t *player);


/*--------------------------------------------------
	INT32 K_PositionBully(player_t *player)

		Calculates a turn value to reach a player that can be bullied.

	Input Arguments:-
		player - Bot to run this for.

	Return:-
		INT32_MAX if couldn't find anything, otherwise a steering value.
--------------------------------------------------*/

INT32 K_PositionBully(player_t *player);


/*--------------------------------------------------
	void K_BuildBotTiccmd(player_t *player, ticcmd_t *cmd);

		Creates a bot's ticcmd, looking at its surroundings to
		try and figure out what it should do.

	Input Arguments:-
		player - Player to generate the ticcmd for.
		cmd - The player's ticcmd to modify.

	Return:-
		None
--------------------------------------------------*/

void K_BuildBotTiccmd(player_t *player, ticcmd_t *cmd);


/*--------------------------------------------------
	void K_BotItemUsage(player_t *player, ticcmd_t *cmd, INT16 turnamt);

		Item usage part of ticcmd generation.

	Input Arguments:-
		player - Player to generate the ticcmd for.
		cmd - The player's ticcmd to modify.
		turnamt - How hard the bot is turning.

	Return:-
		None
--------------------------------------------------*/

void K_BotItemUsage(player_t *player, ticcmd_t *cmd, INT16 turnamt);

#endif