node-haxball
Version:
The most powerful and lightweight API that allows you to develop your original Haxball(www.haxball.com) host, client, and standalone applications both on node.js and browser environments and also includes every possible hack and functionality that you can
396 lines (369 loc) • 14.6 kB
JavaScript
module.exports = function(API){
const { OperationType, VariableType, ConnectionState, AllowFlags, Direction, CollisionFlags, CameraFollow, BackgroundType, GamePlayState, BanEntryType, Callback, Utils, Room, Replay, Query, Library, RoomConfig, Plugin, Renderer, Errors, Language, EventFactory, Impl } = API;
Object.setPrototypeOf(this, Plugin.prototype);
Plugin.call(this, "CMD_autoPlay_mixed_inmemory_multiple", true, { // "CMD_autoPlay_mixed_inmemory_multiple" is plugin's name, "true" means "activated just after initialization". Every plugin should have a unique name.
version: "0.5",
author: "abc",
description: `This is an auto-playing bot that has 2 different modes.
- followBall mode always follows the ball blindly, and kicks it whenever it is nearby without any direction checking.
- defensive mode follows the ball if it is near enough, otherwise goes back and tries to be just in the midpoint of ball and his team's goal line; and kicks the ball whenever it is nearby without any direction checking.
This bot is capable of creating/removing fake bot players(id descending from 65535) in host's memory and controlling all of them at the same time using fake events.
Available commands:
- !add_bot [type = {-1, 0, 1}] [active = {0, 1}] [count] [name="in-memory-bot"] [flag="tr"] [avatar="XX"] [conn="fake-ip-do-not-believe-it"] [auth="fake-auth-do-not-believe-it"]: Adds a new bot with given properties. 0<[count]<=100, [type] = {-1: standing still, 0: followBall, 1: defensive}.
- !remove_bot [count]: Removes the first [count] added bots that is still not removed. 0<[count]<=100.
- !max_bot_count [count]: Sets the maximum allowed concurrent bot count to [count].
- !bot_active [id] [active = {0, 1}]: Changes the activity of the bot player whose playerId is [id].
- !bot_type [id] [type = {-1, 0, 1}]: Sets the bot type of the bot player whose playerId is [id]. [type] = {-1: standing still, 0: followBall, 1: defensive}.
- !bots_active [active = {0, 1}]: (De)activate all bots at once.`,
allowFlags: AllowFlags.CreateRoom // We allow this plugin to be activated on CreateRoom only.
});
this.defineVariable({
name: "minCoordAlignDelta",
description: "Minimum delta value for coordinate alignment",
type: VariableType.Number,
value: 0.5,
range: {
min: 0,
max: 10,
step: 0.5
}
});
this.defineVariable({
name: "minKickDistance",
description: "Minimum distance between ball and bot player for the bot player to start kicking the ball",
type: VariableType.Number,
value: 8,
range: {
min: 0,
max: 15,
step: 0.5
}
});
this.defineVariable({
name: "maxDistanceToFollowBallCoeff",
description: "Coefficient of max distance between ball and player for the bot to follow ball; otherwise it goes back to defense.",
type: VariableType.Number,
value: 0.2,
range: {
min: 0,
max: 1,
step: 0.01
}
});
this.defineVariable({
name: "maxConcurrentBotCount",
description: "Maximum number of concurrently running bots.",
type: VariableType.Integer,
value: 100,
range: {
min: 1,
max: Infinity,
step: 1
}
});
this.defineVariable({
name: "botsActive",
description: "Whether all the bots are active or not.",
type: VariableType.Boolean,
value: true
});
var that = this, permissionCtx, permissionIds;
this.initialize = function(){
permissionCtx = that.room.librariesMap.permissions?.createContext("autoPlayMixedInMemoryMultiple");
if (permissionCtx)
permissionIds = {
addBot: permissionCtx.addPermission("addBot"),
removeBot: permissionCtx.addPermission("removeBot"),
maxBotCount: permissionCtx.addPermission("maxBotCount"),
botActive: permissionCtx.addPermission("botActive"),
botType: permissionCtx.addPermission("botType"),
botsActive: permissionCtx.addPermission("botsActive")
};
that.room.librariesMap.commands?.add({
name: "add_bot",
parameters: [{
name: "type",
type: VariableType.Integer,
range: {
min: -1,
max: 1
}
}, {
name: "active",
type: VariableType.Boolean
}, {
name: "count",
type: VariableType.Integer,
range: {
min: 1,
max: 100
}
}, {
name: "name",
type: VariableType.String,
range: {
min: 1,
max: 40
}
}, {
name: "flag",
type: VariableType.String,
range: {
min: 1,
max: 3
}
}, {
name: "avatar",
type: VariableType.String,
range: {
min: 1,
max: 2
}
}, {
name: "conn",
type: VariableType.String
}, {
name: "auth",
type: VariableType.String
}],
minParameterCount: 3,
helpText: "Adds new bots to the room.",
callback: ({type, active, count, name, flag, avatar, conn, auth}, byId) => {
if (byId!=0 && !permissionCtx?.checkPlayerPermission(byId, permissionIds.addBot)){
that.room.librariesMap.commands?.announcePermissionDenied(byId);
return;
}
addBot(active, type, count, name, flag, avatar, conn, auth);
}
});
that.room.librariesMap.commands?.add({
name: "remove_bot",
parameters: [{
name: "count",
type: VariableType.Integer,
range: {
min: 1,
max: 100
}
}],
minParameterCount: 1,
helpText: "Removes bots from the room.",
callback: ({count}, byId) => {
if (byId!=0 && !permissionCtx?.checkPlayerPermission(byId, permissionIds.removeBot)){
that.room.librariesMap.commands?.announcePermissionDenied(byId);
return;
}
removeBot(count);
}
});
that.room.librariesMap.commands?.add({
name: "max_bot_count",
parameters: [{
name: "count",
type: VariableType.Integer,
range: {
min: 1,
max: 5000
}
}],
minParameterCount: 1,
helpText: "Changes the maximum allowed number of bots",
callback: ({count}, byId) => {
if (byId!=0 && !permissionCtx?.checkPlayerPermission(byId, permissionIds.maxBotCount)){
that.room.librariesMap.commands?.announcePermissionDenied(byId);
return;
}
that.maxConcurrentBotCount = count;
}
});
that.room.librariesMap.commands?.add({
name: "bot_active",
parameters: [{
name: "id",
type: VariableType.Integer,
range: {
min: 0
}
}, {
name: "active",
type: VariableType.Boolean
}],
minParameterCount: 2,
helpText: "Activate/deactivate a bot",
callback: ({id, active}, byId) => {
if (byId!=0 && !permissionCtx?.checkPlayerPermission(byId, permissionIds.botActive)){
that.room.librariesMap.commands?.announcePermissionDenied(byId);
return;
}
var bot = bots.findIndex((x)=>(x.id==id));
if (bot)
bot.active = active;
}
});
that.room.librariesMap.commands?.add({
name: "bot_type",
parameters: [{
name: "id",
type: VariableType.Integer,
range: {
min: 0
}
}, {
name: "type",
type: VariableType.Integer,
range: {
min: -1,
max: 1
}
}],
minParameterCount: 2,
helpText: "Changes the type of a bot.",
callback: ({id, type}, byId) => {
if (byId!=0 && !permissionCtx?.checkPlayerPermission(byId, permissionIds.botType)){
that.room.librariesMap.commands?.announcePermissionDenied(byId);
return;
}
var bot = bots.findIndex((x)=>(x.id==id));
if (bot)
bot.type = type;
}
});
that.room.librariesMap.commands?.add({
name: "bots_active",
parameters: [{
name: "active",
type: VariableType.Boolean
}],
minParameterCount: 1,
helpText: "Activate/deactivate all bots.",
callback: ({active}, byId) => {
if (byId!=0 && !permissionCtx?.checkPlayerPermission(byId, permissionIds.botsActive)){
that.room.librariesMap.commands?.announcePermissionDenied(byId);
return;
}
that.botsActive = active;
}
});
};
this.finalize = function(){
that.room.librariesMap.commands?.remove("add_bot");
that.room.librariesMap.commands?.remove("remove_bot");
that.room.librariesMap.commands?.remove("max_bot_count");
that.room.librariesMap.commands?.remove("bot_active");
that.room.librariesMap.commands?.remove("bot_type");
that.room.librariesMap.commands?.remove("bots_active");
that.room.librariesMap.permissions?.removeContext(permissionCtx);
permissionCtx = null;
permissionIds = null;
};
var smallestBotId = 65535, largestBotId = 65535, bots = [];
var addBot = function(active, type, count, name, flag, avatar, conn, auth){
for (var i=0;i<count;i++){
if (bots.length >= that.maxConcurrentBotCount)
break;
bots.push({
id: smallestBotId,
active: active,
type: type,
keyState: 0
});
that.room.fakePlayerJoin(smallestBotId--, name || "in-memory-bot", flag || "tr", avatar || "XX", conn || "fake-ip-do-not-believe-it", auth || "fake-auth-do-not-believe-it");
}
};
var removeBot = function(count){
for (var i=0;i<count;i++){
if (smallestBotId < largestBotId){
bots.splice(bots.findIndex((x)=>(x.id==largestBotId)), 1);
that.room.fakePlayerLeave(largestBotId--);
}
else
break;
}
};
var update = function(bot, state, x, y, radius){ // ball: x,y,radius
var cp = state.getPlayer(bot.id);
var playerDisc = cp?.disc?.ext;
if (!playerDisc)
return;
var teamId = cp.team.id; // , opponentTeamId = 3 - teamId
var goals = state.stadium.goals;
var targetX, targetY, sqrDistBetweenBallAndPlayer = (x-playerDisc.pos.x) * (x-playerDisc.pos.x) + (y-playerDisc.pos.y) * (y-playerDisc.pos.y);
switch (bot.type){
case 0:{ // always follow ball
targetX = x;
targetY = y;
break;
}
case 1:{ // wait at defense + follow ball when near it
var maxDistanceToFollowBall = that.maxDistanceToFollowBallCoeff * state.stadium.width;
//var b = false;
if (sqrDistBetweenBallAndPlayer > ((playerDisc.radius + radius + maxDistanceToFollowBall) * (playerDisc.radius + radius + maxDistanceToFollowBall))){
var myGoal = goals.filter((g)=>(g.team.id==teamId))[0]; //, opponentGoal = goals[oppositeTeamId - 1];
if (!myGoal)
return;
var MPofMyGoalX = (myGoal.p0.x + myGoal.p1.x) / 2, MPofMyGoalY = (myGoal.p0.y + myGoal.p1.y) / 2;
targetX = (x + MPofMyGoalX) / 2;
targetY = (y + MPofMyGoalY) / 2;
}
else{
targetX = x;
targetY = y;
//b = true;
}
break;
}
default:
return;
}
var deltaX = targetX - playerDisc.pos.x, deltaY = targetY - playerDisc.pos.y, dirX, dirY, kick;
if (Math.abs(deltaX) < that.minCoordAlignDelta)
dirX = 0;
else
dirX = Math.sign(deltaX);
if (Math.abs(deltaY) < that.minCoordAlignDelta)
dirY = 0;
else
dirY = Math.sign(deltaY);
//f(x, y, playerDisc.pos.x, playerDisc.pos.y, myGoal.p0.x, myGoal.p0.y, myGoal.p1.x, myGoal.p1.y)
//var angle_PlayerToBall = Math.atan2(y-playerDisc.pos.y, x-playerDisc.pos.x);
//var angle_BallToGoalDisc1 = Math.atan2(myGoal.p0.y-y, myGoal.p0.x-x);
//var angle_BallToGoalDisc2 = Math.atan2(myGoal.p1.y-y, myGoal.p1.x-x);
var maxSqrDist = (playerDisc.radius + radius + that.minKickDistance) * (playerDisc.radius + radius + that.minKickDistance);
kick = (sqrDistBetweenBallAndPlayer < maxSqrDist);
//console.log(bot.id, sqrDistBetweenBallAndPlayer, maxSqrDist, kick);
// apply current keys
var keyState = Utils.keyState(dirX, dirY, kick);
Utils.runAfterGameTick(()=>{ // this is just a way of doing this outside onGameTick callback.
// sending keystate on EVERY game tick causes desync when you deactivate game's browser tab.
// this happens because requestAnimationFrame is being used.
// therefore, we are trying to limit consequent sending.
if (keyState!=bot.keyState || kick!=cp.isKicking){ // isKicking: whether x key is active in-game (the circle around players is painted white if isKicking is true)
if ((keyState==bot.keyState) && kick && !cp.isKicking) // if keyStates are the same and we are trying to kick, but the x key is not active in game,
that.room.fakeSendPlayerInput(keyState & -17, bot.id); // we have to release x key before pressing it again. (keyState & -17) changes only the 5th(kick) bit of keyState to 0.
that.room.fakeSendPlayerInput(keyState, bot.id); // unlike room.setKeyState, this function directly emits a keystate message.
bot.keyState = keyState;
}
});
};
this.onGameTick = function(customData){
if (!that.botsActive)
return;
// ensure extrapolation of the room state before calculating stuff.
that.room.extrapolate();
// get the extrapolated game state object
var { state, gameState, gameStateExt } = that.room;
gameState = gameStateExt || gameState;
// get the original extrapolated data object of the ball
var {pos, radius} = gameState.physicsState.discs[0] || {};
// get the coordinates and radius of the ball
var {x, y} = pos || {};
// if ball is not reachable, do nothing.
if (x==null || isNaN(x) || !isFinite(x) || y==null || isNaN(y) || !isFinite(y)) // check
return;
bots.forEach((bot)=>{
if (!bot.active)
return;
update(bot, state, x, y, radius);
});
};
};