| Package | com.whirled.contrib.card.trick |
| Class | public class BidEvent |
| Inheritance | BidEvent  flash.events.Event |
| Property | Defined by | ||
|---|---|---|---|
| player : int [read-only] Access the id of the player who has placed a bid, if any.
| BidEvent | ||
| value : int [read-only] Access the value of the bid, if appropriate.
| BidEvent | ||
| Method | Defined by | ||
|---|---|---|---|
|
BidEvent(type:String, player:int = 0, value:int = -1)
Create a new bid event.
| BidEvent | ||
|
clone():Event
| BidEvent | ||
|
newEventType(type:String):String
[static] Placeholder function for Bids subclasses to add new event types.
| BidEvent | ||
|
toString():String
| BidEvent | ||
| Constant | Defined by | ||
|---|---|---|---|
| COMPLETED : String = "bid.completed" [static] Event type for when all bids are in.
| BidEvent | ||
| PLACED : String = "bid.placed" [static] Event type for when a bid is placed.
| BidEvent | ||
| REQUESTED : String = "bid.requested" [static] Event type for when a bid is requested.
| BidEvent | ||
| RESET : String = "bid.reset" [static] Event type for when the bids are reset.
| BidEvent | ||
| SELECTED : String = "bid.selected" [static] Event type for when a bid is selected.
| BidEvent | ||
| _player | property |
protected var _player:int
| player | property |
player:int [read-only]Access the id of the player who has placed a bid, if any.
Implementation public function get player():int
| _value | property |
protected var _value:int
| value | property |
value:int [read-only]Access the value of the bid, if appropriate.
Implementation public function get value():int
| BidEvent | () | constructor |
public function BidEvent(type:String, player:int = 0, value:int = -1)Create a new bid event.
Parameterstype:String |
|
player:int (default = 0) |
|
value:int (default = -1) |
| clone | () | method |
public override function clone():EventReturns
Event |
| newEventType | () | method |
public static function newEventType(type:String):StringPlaceholder function for Bids subclasses to add new event types.
Parameterstype:String |
String |
| toString | () | method |
public override function toString():StringReturns
String |
| COMPLETED | constant |
public static const COMPLETED:String = "bid.completed"Event type for when all bids are in. For this event type, the player and value properties are not used.
| PLACED | constant |
public static const PLACED:String = "bid.placed"Event type for when a bid is placed. For this event type, the value is set to the amount bid and the player is set to the id of the player who bid.
| REQUESTED | constant |
public static const REQUESTED:String = "bid.requested"Event type for when a bid is requested. For this event type, the player is set to the id of the player who is requested to bid and the value is set to the maximum amount.
| RESET | constant |
public static const RESET:String = "bid.reset"Event type for when the bids are reset. For this event type, the player and value properties are not used.
| SELECTED | constant |
public static const SELECTED:String = "bid.selected"Event type for when a bid is selected. For this event type, the value is set to the amount selected and the player is set to the id of the player who bid.