Files
vilya/src/as/com/threerings/ezgame/OccupantChangedEvent.as
T
Ray Greenwell 0a4d59ee8f Documentation improvements.
Removed the superfluous EZEvent.


git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@554 c613c5cb-e716-0410-b11b-feb51c14d237
2008-02-05 08:11:24 +00:00

82 lines
2.4 KiB
ActionScript

//
// $Id$
//
// Vilya library - tools for developing networked games
// Copyright (C) 2002-2007 Three Rings Design, Inc., All Rights Reserved
// http://www.threerings.net/code/vilya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package com.threerings.ezgame {
import flash.events.Event;
/**
* Dispatched when an occupant enters or leaves.
*
* If a watcher becomes a player, you may get an OCCUPANT_LEFT event where player == false,
* followed immediately by an OCCUPANT_ENTERED event where player == true.
*/
public class OccupantChangedEvent extends Event
{
/**
* @eventType OccupantEntered
*/
public static const OCCUPANT_ENTERED :String = "OccupantEntered";
/**
* @eventType OccupantLeft
*/
public static const OCCUPANT_LEFT :String = "OccupantLeft";
/** The occupantId of the occupant that entered or left. */
public function get occupantId () :int
{
return _occupantId;
}
/** Is/was the occupant a player? If false, they are/were a watcher. */
public function get player () :Boolean
{
return _player;
}
public function OccupantChangedEvent (type :String, occupantId :int, player :Boolean)
{
super(type);
_occupantId = occupantId;
_player = player;
}
override public function toString () :String
{
return "[OccupantChangedEvent type=" + type +
", occupantId=" + _occupantId +
", player=" + _player + "]";
}
override public function clone () :Event
{
return new OccupantChangedEvent(type, _occupantId, _player);
}
/** @private */
protected var _occupantId :int;
/** @private */
protected var _player :Boolean;
}
}