Package event

Class OutOfBoundsEvent

java.lang.Object

event.GameEvent

event.OutOfBoundsEvent

public class OutOfBoundsEvent
extends GameEvent

Represents an event where an entity crosses a screen edge.

Author:

Krish Pillai

See Also:

• Configuration.Direction

Constructor Summary

Constructors

Constructor	Description
OutOfBoundsEvent(OutOfBoundsEvent event)	Copy constructor for the event
OutOfBoundsEvent(EntityModel entity, ScreenBoundary boundary)
OutOfBoundsEvent(EntityModel entity, ScreenBoundary boundary, String description)	Constructor for Out-of-Bounds event containing the entity and the edge it crossed.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
ScreenBoundary	getBoundary()	Getter for the boundary crossed
Configuration.Direction	getEdge()	Getter for the edge that has been crossed
EntityModel	getEntity()	Getter for the entity stepping out of bounds

Methods inherited from class event.GameEvent

getDescription, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

OutOfBoundsEvent

public OutOfBoundsEvent(EntityModel entity,
 ScreenBoundary boundary)

OutOfBoundsEvent

public OutOfBoundsEvent(EntityModel entity,
 ScreenBoundary boundary,
 String description)

Constructor for Out-of-Bounds event containing the entity and the edge it crossed.

Parameters:

entity - The entity firing the event

boundary - The screen edge that was crossed

description - a description of the event or the empty string

See Also:

• EntityModel
• Configuration.Direction

OutOfBoundsEvent

public OutOfBoundsEvent(OutOfBoundsEvent event)

Copy constructor for the event

Parameters:

event - The event being duplicated

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class GameEvent

getEntity

public EntityModel getEntity()

Getter for the entity stepping out of bounds

Returns:

a the out-of-bounds entity

getBoundary

public ScreenBoundary getBoundary()

Getter for the boundary crossed

Returns:

a the screen boundary

See Also:

• ScreenBoundary

getEdge

public Configuration.Direction getEdge()

Getter for the edge that has been crossed

Returns:

the edge of the screen boundary

See Also:

• ScreenBoundary.getEdge()
• Configuration.Direction