Event Summary

Field Summary

Method Summary

Parameters:

name

Name of user to add

Example:

es.addBuddy("jobem");

Parameters:

tempUsername		Username of admin
tempPassword		Password of admin

Example:

es.adminLogin("system", "electroserver");

Parameters:

name		Name of user to be banned
reason		Reason for banning
expires		The amount of time that the user should be banned in minutes

Example:

The following bans someone for 20 minutes. es.ban("jobem", "You have repeatedly been mean.", 20);

Parameters:

detail		The name of the attribute to change
value		The new value for the attribute that is changing

Example:

Makes a room hidden:

es.changeRoomDetail("hidden", true);

Changes the password of your room:

es.changeRoomDetail("password", "myNewPass");

Changes the description object:

var ob:Object = new Object();
ob.attributes = new Object();
ob.description = "A cool room";
ob.attributes.some_useful_variable = "asdf";
es.changeRoomDetails("description", ob);

Example:

es.close();

Parameters:

tmp_ip		The ip address of ElectroServer
tmp_port		The port over which ElectroServer is listening

Example:

Usage 1:

es.setIP("127.0.0.1");
es.setPort(9875);
es.connect();

Usage 2:

es.connect("127.0.0.1", 9875);

Parameters:

roomOb

Object describing room to be created

Example:

var roomOb:Object = new Object();
roomOb.zone = "Game Zone";
roomOb.roomName = "DiePleez";
es.createGameRoom(roomOb);

Parameters:

roomOb		An object representing the room to be created
auto		Boolean value, default is true. If true and the room that you are creating already exists, then you'll be joined to that room.

Example:

Here is the most basic way to create a room:

var roomOb:Object = new Object();
roomOb.zone = "Chat Area";
roomOb.roomName = "Lobby";
es.createRoom(roomOb);

Here is a long-winded example of creating a room with all properties used except plug-ins:

var roomOb:Object = new Object();
roomOb.zone = "Chat Area";
roomOb.roomName = "Lobby";
roomOb.hidden = false;
roomOb.numbered = false;
roomOb.userVariablesEnabled = false;
roomOb.description = "You can chat all day long in this room!";
roomOb.password = "";
roomOb.capacity = -1;
roomOb.updatable = true;
//room vars
roomOb.roomVariables = new Array();
var ob:Object = new Object();
ob.name = "BackgroundMusic";
ob.data = "AmbientSounds";
roomOb.roomVariables.push(ob);
//end room vars
es.createRoom(roomOb);

Here is an example creating a room with two plugins:

var roomOb:Object = new Object();
roomOb.zone = "Chat Area";
roomOb.roomName = "Lobby";
roomOb.plugins = new Array();
roomOb.plugins.push({name:"ShootEmUpPlugin"});
roomOb.plugins.push({name:"ScoreSaverPlugin"});
es.createRoom(roomOb);

Parameters:

ob

An object containing many optional properties. Here are those properties: name The name of the room variable to be created or updated. (String) data The value of the room variable to be created or updated. (String) locked Optional property. If true then the variable can not be modified once created in the room, however it can still be deleted. The default value is false. (Boolean) persistent Optional property. If true then the variable remains in the room after the user that created it leaves the room. If false then the variable is deleted when the user who created it leaves the room. The default value is false.

Example:

The following code creates a room variable on the server in your current room. The variable is not locked and will be removed when you leave the room:

var ob = new Object();
ob.name = "NumberOfBadGuys";
ob.data = "30";
es.createRoomVariable(ob);

The following code creates a room variable on the server in your current room. This variable is locked, meaning that it cannot be modifed (only deleted). It is also persistent, which means it will not die if you leave the room:

var ob:Object = new Object();
ob.name = "secretDoorUnlocked";
ob.data = "true";//this is a string because all room variables are strings
ob.locked = true;
ob.persistent = true;
es.createRoomVariable(ob);

Parameters:

name		Name of the user variable
value		Value of the variable

Example:

To create a user variable on yourself: es.createUserVariable("myIcon", "happy face"); To trace everyone's user variables:

var userlist:Array = es.getUserList();
for (var i=0;i<userlist.length;++i) {
	var user:Object = userlist[i];
	var userVariables:Object = user.userVariables;
	trace("User variables for "+user.Name.value);
	for (var name in userVariables) {
		trace(" variable name: "+name);
		trace(" variable value: "+userVariables[name]);
	}
}

Parameters:

name

The name of the room variable to delete

Example:

es.deleteRoomVariable("welcomeMessage");

Parameters:

name

Name of variable to be deleted

Example:

es.deleteUserVariable("myIcon");

Example:

es.allZonesLoaded = function(zones:Array) {
	trace("--All Zones--");
	for (var i=0;i<zones.length;++i) {
		trace(zones[i]);
	}
}
es.getAllZones();

Example:

var myBuddies:Array = es.getBuddyList();
for (var i=0;i<myBuddies.length;++i) {
	var buddy:Object = myBuddies[i];
	trace(buddy.username);
}

Alternative usage: Also works with a list box component

myList_lb.dataProvider = es.getBuddyList();

Example:

var debugVal:Boolean = es.getDebug();

Example:

var es:ElectroServer = ElectroServer.getInstance();

Example:

var ip:String = es.getIP();

Example:

es.loggedInUserCountUpdated = function(count:Number) {
	trace("users connected: "+count);
}
es.getLoggedInUserCount();

Example:

var port:Number = es.getPort();

Returns:

Object that describes the room that you are in.

Example:

var myRoomName:String = es.getRoom().Name.value

Returns:

An array. Each element in the array is an object.

Example:

The code that follows is a simple way to just display the rooms in your current zone in an HTML enabled text filed. Note: this does not make use of the the other properties of the room objects.

function showRooms() {
	var roomListBoxStr:String = "";
	var roomlist:Array = es.getRoomList();
	for (var i = 0; i<roomlist.length; ++i) {
		var room:Object = roomlist[i];
		roomListBoxStr += room.name.value+"<br>";
	}
	roomListBox.htmlText = roomListBoxStr;
}

Parameters:

tmp_zone

The name of the zone

Example:

es.onRoomsInZoneLoaded = function(roomlist:Array, zoneName:String) {
	trace("Room list loaded for " +zoneName);
	for (var i=0;i<roomlist.length;++i) {
		var room:Object = roomlist[i];
		trace(room.Name.value);
	}
}
es.getRoomsInZone("Golf Zone");

Returns:

An object. Each property in the object is a variable for that room.

Example:

To simply show all of the room variables for a room in the output window, use the following code:

function showRoomVariables() {
	var roomVariables:Object = es.getRoomVariables();
	for (var i in roomVariables) {
		trace(i+"="+roomVariables[i]);
	}
}

Or you can access a room variable directly like the following:

var musicLoop:String = es.getRoomVariables().musicLoop;

Example:

es.onGetServerTime = function(time:Number) {
	trace("server time: "+time);
}
es.getServerTime();

Returns:

Returns an object representing you.

Example:

The following just traces your username:

trace(es.getUser().Name.value);

The following returns the number associated with you in a game.

var myNum:Number = es.getUser().AssignedNumber.value;

Returns:

An array of objects. Each object describes a user in your room.

Example:

This gets the user list, loops through it, and traces out the names of the users.

var list:Array = es.getUserList();
for (var i=0;i<list.length;++i) {
	var user:Object = list[i];
	trace(user.Name.value);
}

Parameters:

name

The name of the user

Example:

es.getUserLocation("jobem");
//Capture the response
es.userLocationLoaded = function(username, zone, room) {
	trace(username+", "+zone+", "+room);
};

Parameters:

zone		The zone that the room is in
room		The room you are interested in

Example:

es.usersInRoomLoaded = function(userlist:Array, roomName:String, zoneName:String) {
	trace("--user list loaded for zone: "+zoneName+", roomName");
	for (var i=0;i<userlist.length;++i) {
		var user:Object = userlist[i];
		trace(user.Name.value);
	}
}
es.getUsersInRoom("Chat Area", "Lobby");

Returns:

An object representing the zone that you are in.

Example:

var myZone:Object = es.getZone();
trace(myZone.name);
trace(myZone.numUsers);

Parameters:

room		The name of the room
password		The password for the room, if any.
type		Either "player" or "spectator" depending on why you're joining the game.
zone		The name of the zone if it differs from the one you're currently in.

Example:

es.joinGame("Mini Golf 173", "", "player");

Parameters:

room		Name of the room to join
password		Password for the room, if any (optional)
zoneName		The name of the zone that the room is in. Only needed if it is in a different zone then you are currently in. (Optional)
numbered		Either 'true' or 'false'. If 'true', then you are given a number in the room. This can be useful in some games. (Optional)

Example:

es.joinRoom("Lobby", "", "Chat Area"); or,

es.joinRoom("SecretRoom", "secret_password", "Chat Area");

or if you are already in a zone and want to join another room in that zone with no password, then it can be condensed to this:

es.joinRoom("Game talk");

Parameters:

name		Name of the user to be kicked
reason		Reason for kicking

Example:

es.kick("jobe", "for being too cool");

Example:

es.configurationLoaded = function(ob:Object) {
	//config loaded
}
es.loadConfiguration();

Parameters:

tempUsername		The username to use
tempPassword		The password to use. (Optional)
variables		An object containing variables to be sent to ElectroServer. This is useful when using a custom server-side login event handler. (Optional)

Example:

function loginResponse(success:Boolean, error:String) {
	//This function is called when the server responds after a login request is sent
	if (success) {
		//properly logged in
		gotoAndStop("Chat")
	} else {
		//not properly logged in, there was an error
		msg.text = error;
		trace(error);
		gotoAndStop("Error")
	}
}
es.loggedIn = loginResponse;
es.login("jobem");

Parameters:

disconnect

Boolean value. If true then you are disconnected from ElectroServer too. If false, then your connection persists and you can re-login.

Example:

es.logout();

Parameters:

plugin		Name of the plugin that you are trying to communicate with. This is specified in the configuration.xml file.
method		This is a string that the plugin will use to determine what to do with your request.
parameters		This is an optional parameter, an object of name value pairs. All values should be strings.

Example:

The following could work with a plugin written to store white board data. The white board could then inform all new users to the room of the current state of the board. This code could tell the plugin to draw a line. It is then up to the plugin to send this information to the other people in the room.

var parameters:Object = new Object();
parameters.startx = 200;
parameters.endx = 300;
parameters.starty = 37;
parameters.endy = 110;
parameters.color = "blue";
es.pluginRequest("WhiteBoardScriptPlugin", "DrawLine", parameters);

Parameters:

name

The name of the plugin

Example:

es.registerRawHandler("ShootemUpPlugin");

Parameters:

name

Username to remove

Example:

var user:String = "jobe";
es.removeBuddy(user);

Parameters:

type		To send to the room this should be "public" or "all". To send to an array of users it should be "private".
message		The string message to send.
users		The array of users to send to. Each element should be a username.
variables		An object of name value pairs. Each value should be a string.

Example:

Here is the most simple example of sending a message to a room:

var message:String = "Hello world!";
es.sendMessage("public", message);

Here is a simple of example of how to send a message to a room with variables:

var message:String = "Hello world!";
var variables:Object = new Object();
variables.textColor = "yellow";
variables.soundToPlay = "boink";
es.sendMessage("public", message, variables)

Here is a simple example of how to send a private message to three people with variables:

var message:String = "Hello world!";
var variables:Object = new Object();
variables.textColor = "yellow";
variables.soundToPlay = "boink";
var users:Array = new Array();
users.push("Kelly");
users.push("Robert");
users.push("Mike");
es.sendMessage("private", message, users, variables);

Parameters:

who		Should be the string "all" or an array of user names. (String or Array)
ob		An ActionScript object to send to the other users (Object)

Example:

Here is a simple example of how to send a chess move to another user.

var ob:Object = new Object();
ob.action = "move_piece";
ob.piece = "white_queen";
ob.y_tile = 7;
ob.x_tile = 6;
es.sendMove("all", ob);

Here is an example of how you could send an array to everyone in your room.

var ob:Object = new Object();
ob.action = "ListOfFriends";
ob.friends = new Array ("Jobe", "Mike", "Robert", "Kelly");
es.sendMove("all", ob);

What follows is an example of a private game move that is send to only 2 other people. Let's say they are on your team in the game. You are giving them some ammo.

var ob:Object = new Object();
ob.action = "GiveAmmo";
ob.ammoType = "Uzi";
es.sendMove(["mike", "robert"], ob);

Parameters:

str

The raw string to send.

Example:

es.sendRaw("t|23|f|90");

Parameters:

val

Boolean value. If true then debugging is enabled.

Example:

es.setDebug(true);

Parameters:

tempIP

The ip address to connect to.

Example:

es.setIP("127.0.0.1");
es.setPort(9875);
es.connect();

Parameters:

val		A Boolean value. If true then it will show the moderator label.
str		The string to append to the front of a moderator's label

Example:

es.setModeratorLabel(true, "[mod]");

Parameters:

tempPort

The port to use

Example:

es.setIP("127.0.0.1");
es.setPort(9875);
es.connect();

Parameters:

name		The name of the variable to update
value		The new value of the variable

Example:

es.updateUserVariable("myIcon", "sadFace");