AlpacaLibary  1.63
A closed source C++ bot for OSRS
Tile Class Reference

#include <Tile.hpp>

Public Member Functions

 Tile ()
 
 Tile (std::int32_t X, std::int32_t Y, std::int32_t Plane=0)
 
 Tile (const Tile &T)
 
double DistanceFrom (const Tile &T) const
 
bool IsNegative () const
 
bool IsPositive () const
 
bool operator== (const Tile &T) const
 
bool operator!= (const Tile &T) const
 
Tile operator+ (const Tile &T) const
 Adds the x-axis and y-axis coordinates, plane is ignored. More...
 
Tile operator- (const Tile &T) const
 Subtracts the x-axis and y-axis coordinates, plane is ignored. More...
 
Tileoperator+= (const Tile &T)
 Adds the x-axis and y-axis coordinates, plane is ignored. More...
 
Tileoperator-= (const Tile &T)
 Subtracts the x-axis and y-axis coordinates, plane is ignored. More...
 
 operator bool () const
 
 ~Tile ()
 

Public Attributes

std::int32_t X
 The x-axis coordinate. More...
 
std::int32_t Y
 The y-axis coordinate. More...
 
std::int32_t Plane
 The plane the tile exists on (usually 0-4) More...
 

Friends

std::ostream & operator<< (std::ostream &OS, const Tile &T)
 

Detailed Description

Definition at line 7 of file Tile.hpp.

Constructor & Destructor Documentation

◆ Tile() [1/3]

Tile::Tile ( )

◆ Tile() [2/3]

Tile::Tile ( std::int32_t  X,
std::int32_t  Y,
std::int32_t  Plane = 0 
)
Parameters
XThe X-axis coordinate
YThe Y-axis coordinate
PlaneThe plane the tile exists on (usually 0-4)

◆ Tile() [3/3]

Tile::Tile ( const Tile T)

◆ ~Tile()

Tile::~Tile ( )

Member Function Documentation

◆ DistanceFrom()

double Tile::DistanceFrom ( const Tile T) const

◆ IsNegative()

bool Tile::IsNegative ( ) const
Returns
True if any of x, y, or plane are negative in value

◆ IsPositive()

bool Tile::IsPositive ( ) const
Returns
True if all of x, y, and plane are positive in value

◆ operator bool()

Tile::operator bool ( ) const
Returns
True if this is not negative
See also
IsNegative

◆ operator!=()

bool Tile::operator!= ( const Tile T) const
Returns
True if any of the comparative tile x, y, or plane are not equal

◆ operator+()

Tile Tile::operator+ ( const Tile T) const

Adds the x-axis and y-axis coordinates, plane is ignored.

◆ operator+=()

Tile& Tile::operator+= ( const Tile T)

Adds the x-axis and y-axis coordinates, plane is ignored.

◆ operator-()

Tile Tile::operator- ( const Tile T) const

Subtracts the x-axis and y-axis coordinates, plane is ignored.

◆ operator-=()

Tile& Tile::operator-= ( const Tile T)

Subtracts the x-axis and y-axis coordinates, plane is ignored.

◆ operator==()

bool Tile::operator== ( const Tile T) const
Returns
True if the comparative tile x, y, and plane are all equal

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  OS,
const Tile T 
)
friend

Member Data Documentation

◆ Plane

std::int32_t Tile::Plane

The plane the tile exists on (usually 0-4)

Definition at line 21 of file Tile.hpp.

◆ X

std::int32_t Tile::X

The x-axis coordinate.

Definition at line 19 of file Tile.hpp.

◆ Y

std::int32_t Tile::Y

The y-axis coordinate.

Definition at line 20 of file Tile.hpp.


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