C# Class MBC.Shared.Entities.Ship

Inheritance: System.Entity

Public Methods

Method	Description
ConflictsWith ( Ship otherShip ) : bool	Checks if another Ship occupies any cells that this Ship occupies.
Hit ( Coordinates coords ) : void	Hits the ship at the coordinates.
IsAt ( Coordinates location ) : bool	Indicates whether or not a location is an occupied cell.
IsHitAt ( Coordinates location ) : bool	Checks whether the hit flag has been set at the specific ship location index.
IsSunk ( ) : bool
Place ( Coordinates location, ShipOrientation orientation ) : void	Places this Ship with the location and orientation. Sets the state of being placed to true.
Reset ( ) : void	Resets the ship back to its initialized state.
Ship ( System.Entity parent, int length ) : System	Sets the length of the Ship to length. The length must be at least 1.
Ship ( Ship shipCopy ) : System	Copies an existing Ship.
Sink ( ) : void	Sinks the ship
ToString ( ) : string	Provides a string representation.

Method	Description
GetAllLocations ( ) : IEnumerable

Checks if another Ship occupies any cells that this Ship occupies.

public ConflictsWith ( Ship otherShip ) : bool
otherShip	Ship	The to check for confliction with.
return	bool

Hits the ship at the coordinates.

public Hit ( Coordinates coords ) : void
coords	Coordinates
return	void

Indicates whether or not a location is an occupied cell.

public IsAt ( Coordinates location ) : bool
location	Coordinates	The of the location to check.
return	bool

Checks whether the hit flag has been set at the specific ship location index.

public IsHitAt ( Coordinates location ) : bool
location	Coordinates
return	bool

public IsSunk ( ) : bool
return	bool

Places this Ship with the location and orientation. Sets the state of being placed to true.

public Place ( Coordinates location, ShipOrientation orientation ) : void
location	Coordinates	The of the bottom-most/left-most part of /// the .
orientation	ShipOrientation	The to set.
return	void

Resets the ship back to its initialized state.

public Reset ( ) : void
return	void

Sets the length of the Ship to length. The length must be at least 1.

Thrown when the is less /// than 1.

public Ship ( System.Entity parent, int length ) : System
parent	System.Entity
length	int	The number of cells the occupies.
return	System

Copies an existing Ship.

public Ship ( Ship shipCopy ) : System
shipCopy	Ship
return	System

Sinks the ship

public Sink ( ) : void
return	void

Provides a string representation.

public ToString ( ) : string
return	string