Tiles.Property Class Reference

Inherits from tile class, describes a purchasable tile that can be owned by a player or the bank. More...

Inheritance diagram for Tiles.Property:

Public Member Functions
override void	OnLanded (Player player)
	Handles functionality for player landing on this tile.
void	Mortgage ()
	Mortgages this property.
void	SellProperty ()
	Sells this property to the bank.
Public Member Functions inherited from Tiles.Tile
void	SetUp (string name)
void	ShowOutline (Color startColor, Color endColour)
void	HideOutline ()

Protected Member Functions
void	SetUp (string name, int cost, int propertyNumber)
override void	SetBoardTile ()
	Sets the name/cost text of this tile on the board.
override void	ShowCard ()
override void	HideCard ()
virtual void	PayRent (Player player)
	Handles paying rent to the owner of this property. This functionality is specific to properties.
Protected Member Functions inherited from Tiles.Tile
virtual void	SetCard ()
	Sets the visual tile card from a prefab depending on the type of the tile.
void	ShowOutline ()
virtual void	OnMouseEnter ()
virtual void	OnMouseExit ()

Protected Attributes
int	CurrentRent

Properties
Player	OwnedBy [get, set]
int	Cost [get]
int	PropertyNumber [get]
bool	Mortgaged [get, set]
int	MortgagedValue [get]
int	UnmortgagedValue [get]
Properties inherited from Tiles.Tile
string	Name [get, protected set]
GameObject	Card [get, protected set]
bool	InMortgageSelection [get, set]
bool	InUnmortgageSelection [get, set]
bool	InSellPropertySelection [get, set]

Detailed Description

Inherits from tile class, describes a purchasable tile that can be owned by a player or the bank.

Member Function Documentation

HideCard()

override void Tiles.Property.HideCard ( )

protectedvirtual

Reimplemented from Tiles.Tile.

OnLanded()

override void Tiles.Property.OnLanded ( Player player )

virtual

Handles functionality for player landing on this tile.

Parameters

player

The player that landed on the tile

Reimplemented from Tiles.Tile.

PayRent()

virtual void Tiles.Property.PayRent ( Player player )

protectedvirtual

Handles paying rent to the owner of this property. This functionality is specific to properties.

Parameters

player

The player that needs to pay rent to the owner

Reimplemented in Tiles.Station, Tiles.Street, and Tiles.Utility.

SetBoardTile()

override void Tiles.Property.SetBoardTile ( )

protectedvirtual

Sets the name/cost text of this tile on the board.

Reimplemented from Tiles.Tile.

ShowCard()

override void Tiles.Property.ShowCard ( )

protectedvirtual

Reimplemented from Tiles.Tile.

---

The documentation for this class was generated from the following file:

• PropertyTycoon/Assets/Scripts/Tiles/Property.cs