Adonthell  0.4
mapsquare_area Class Reference

Area of mapsquares, for use with landmap. More...

#include <mapsquare.h>

Public Member Functions

 mapsquare_area ()
 Default constructor. More...
 
 ~mapsquare_area ()
 Destructor. More...
 
void clear ()
 Totally clears the area. More...
 

Area settings

class mapcharacter
 
class mapview
 
class landmap
 
u_int16 area_length () const
 Returns the length of the area. More...
 
u_int16 area_height () const
 Returns the height of the area. More...
 
mapsquareget_square (u_int16 x, u_int16 y) const
 Returns a pointer to a desired square. More...
 
void resize_area (u_int16 nl, u_int16 nh)
 Resize the area. More...
 

Detailed Description

Area of mapsquares, for use with landmap.

This class has no reason to exist is not belonging to a landmap. You'll NEVER use this class directly - anyway you can't do anything usefull with it alone.

Definition at line 372 of file mapsquare.h.

Constructor & Destructor Documentation

◆ mapsquare_area()

mapsquare_area::mapsquare_area ( )

Default constructor.

Definition at line 95 of file mapsquare.cc.

◆ ~mapsquare_area()

mapsquare_area::~mapsquare_area ( )

Destructor.

Definition at line 99 of file mapsquare.cc.

Member Function Documentation

◆ clear()

void mapsquare_area::clear ( )

Totally clears the area.

Definition at line 103 of file mapsquare.cc.

◆ area_length()

u_int16 mapsquare_area::area_length ( ) const
inline

Returns the length of the area.

Returns
length (in number of squares) of the area.

Definition at line 405 of file mapsquare.h.

◆ area_height()

u_int16 mapsquare_area::area_height ( ) const
inline

Returns the height of the area.

Returns
height (in number of squares) of the area.

Definition at line 416 of file mapsquare.h.

◆ get_square()

mapsquare* mapsquare_area::get_square ( u_int16  x,
u_int16  y 
) const
inline

Returns a pointer to a desired square.

Parameters
xX position of the square to get.
yY position of the square to get.
Returns
pointer to the (x,y) square.

Definition at line 430 of file mapsquare.h.

◆ resize_area()

void mapsquare_area::resize_area ( u_int16  nl,
u_int16  nh 
)

Resize the area.

Parameters
nlnew length (in number of squares) of the area.
nhnew height (in number of squares) of the area.

Definition at line 237 of file mapsquare.cc.


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