Navigation: battleWarden:Script > API Reference >

Server

 

 

The server module gives you access to the core functionality of battleWarden EX by enabling you to communicate with a game server that supports BattlEye.

Server Module API

Syntax

Parameters

Return Value

Description

Connect(host AS STRING, port AS INTEGER, password AS STRING) AS INTEGER

host: specifies the host name (IP) of the server to connect to.

 

port: specifies the port of the server to connect to.

 

password: specifies the password of the server to connect to. 

1 if succeed, otherwise 0.

Connects to a BE server.

Disconnect()  AS VOID

none

none

Disconnects from the current BE server.

BESendCommand(command AS STRING) AS VOID

commands: specifies the BattlEye command.

none

Sends a command to the BE server battleWarden is connected to. See https://community.bistudio.com/wiki/BattlEye for more information

BEGetBanList() AS INTEGER      

none

Number of bans.

Receives the whole ban list and prepares for examination.

BENextBanListElement() AS INTEGER  

 

1 if another ban entry exists, otherwise 0.

Changes the current ban entry to the next entry. You should call BEGetBanList first before using this command!

BEGetCurrentBanID() AS STRING 

none

ID (GUID or IP) of the current ban entry.

Returns the ID (GUID or IP) of the current ban entry.

BEGetCurrentBanDuration() AS STRING

none

Duration of current ban entry.

Returns the duration of the current ban entry.

BEGetCurrentBanReason() AS STRING   

none

Reason of the current ban entry.

Returns the reason of the current ban entry.

BEGetPlayerList() AS INTEGER 

none

Number of active clients/players on the server.

Receives the whole player list and prepares for examination.

BENextPlayerListElement() AS INTEGER

none

1 if another entry exists, otherwise 0.

Changes the current player entry to the next entry.  You should call BEGetPlayerList first before using this command!

BEGetCurrentPlayerName() AS STRING 

none

Name of current player entry.

Returns the name of the current player entry.

BEGetCurrentPlayerScore() AS INTEGER

none

Score of the current player entry.

Reserved.

BEGetCurrentPlayerDeaths() AS INTEGER

none

Deaths of the current player entry.

Reserved.

BEGetCurrentPlayerTeam() AS STRING

none

Team name of the current player entry.

Reserved.

BEGetCurrentPlayerPing() AS INTEGER

none

Ping of the current player entry.

Returns the ping of the current player entry.

BEGetCurrentPlayerIP() AS STRING 

none

IP of the current player entry.

Returns the IP of the current player entry.

Copyright © 2016 solicus. All Rights Reserved. Last Update: 2016-4-7.