Clientside Script Support

BWAdmin Version 5.0

BWAdmin Compatibility

remoteEval (2048, bwadmin::isCompatible, getManagerId());
Clientside check for bwadmin compatibility.
 
remotebwadmin::Compatible(%client, %version)
Receives the info where version will be the client support version (ie. 5)
 
remoteEval (2048, bwadmin::EnableSupport, getManagerId(),"ObjectiveInfo");
Requests server support for a particular type of info, in this case ObjectiveInfo.
Possible types are:
ObjectiveInfo - Will return the current objective capture info on player connection
KillInfo - sends who killed who with what. No more killtrak parsing :)
PilotingInfo - informs script when player enters and leaves a vehicle as pilot
StationType - informs script of station type and how many repair kits a player needs to take him to full health
WeaponChangeInfo - informs when player changes weapon and to what.
 
remotebwadmin::SupportVerify(%client, %type, %enable)
Recieves server response from above. A true value for enable means that support was registered correclty and the info will now be sent upon events. %type is type as above.
 
remotebwadmin::KillInfo(%client, %killerid, %victimid, %weapon)
Recieves killtrak events. Recieves the clientids of both the killer and the victim and the weapon type that did the damage. Weapon types are:
%weapon = "Landing";
%weapon = "Impact"; //collisiion with vehicle
%weapon = "Chaingun";
%weapon = "Turret";
%weapon = "Plasma";
%weapon = "Disc"; //Disc Launcher
%weapon = "Grenade"; //Grenade Launcher
%weapon = "Laser";
%weapon = "Mortar";
%weapon = "Blaster";
%weapon = "ELF"; //Elf gun and elf turret
%weapon = "Crush"; //Elevators, etc
%weapon = "Debris"; //Exploding vehicles, invs, etc
%weapon = "Missle"; //Flyer and turret missles
%weapon = "Mine"; //Mines and Grenades
remotebwadmin::PilotingInfo(%client, %active)
Recieves pilot data. %active = true then player became a pilot, false he is no longer a pilot
 
remotebwadmin::WeaponChangeInfo(%client, %weapon)
Returns the wepaon name that the player has changed to. Most useful for reticle changers
 
remotebwadmin::StationInfo(%client, %type, %noofkits)
Returns the station type (eg. PortableInvStation) and the number of kits that the player requires to be at full health and have one spare to carry. This saves scripts being over-hungry at portable inventorys.

 

Admin-only Functions

remoteEval(2048, bwadmin::getPlayerList);
Requests a list of current players and their info.

remotebwadmin::setPlayerList(%server, %cl, %ip, %realname, %email, %tribe, %url, %other) 
Receives the player info.

remoteEval(2048, bwadmin::teamSwap, %swap);
%swap true instructs the server to swap team names and skins on map change.
%swap false cancels.

Observer Functions

remoteEval(2048, bwadmin::zoom(%zoom));
Zoom to %zoom in meters. Maximum 30 meters. 
Minimum -1 unless observing an objective when it will be 5, unless set to -3 specifically.
Standard settings for observing players follow:
-1 In eyes
-3 Chase
5 Inner Orbit (default)
10 Outer Orbit 
20 Extreme Orbit

remoteEval(2048, bwadmin::observeClient(%clientId)):
Observe a client by client number.

remoteEval(2048, bwadmin::observeObjective(%targetName));
Observe an objective by name.

remoteEval(2048, bwadmin::observerFreeFly);
Enter free flight from current location.

remoteEval(2048, bwadmin::observeObjective);
Enter observe objective mode.

 

Info Functions

remoteEval(2048, bwadmin::reg);
registers the player to automatically receive info on who/what is currently observed.
Also triggers initial teamscore, playerscore and objectivelist remotes.

remotebwadmin::observed(%server, %observedName, %defaultZoomLevel)
receives the above info on who/what is currently observed and current default zoom level (i.e. manually unaltered).

remotebwadmin::setObjList(%server, %objNumber, %totalNumObjectives, %objName, %objType, %objStatus)
Receives objective listing and details on connect and map change if registered.

remoteEval(2048, bwadmin::teamScoreList);
Responds with function remotebwadmin::setTeamScoreList(%server, %team, %teamName, %players, %teamScore, %scoreLimit)

remoteEval(2048, bwadmin::playerScoreList);
CURRENTLY DISABLED, however the response is called on connect if registered.
Responds with function remotebwadmin::setPlayerScoreList(%server, %clientNumber, %score).


Legacy Functions - These appear in older versions of BWAdmin and are no longer supported.

remoteEval(2048, bwadmin::getMatchInfo);
Requests general match info.

remotebwadmin::setMatchInfo(%server, %time, %team, %teamName, %players, %score, %carrier)
Receives general match info.

remoteEval(2048, bwadmin::observeFlag(%teamNumber));
Observe a flag by team number.