Adonthell  0.4
mapsquare_walkable Class Reference

Contains information about the walkability of a mapsquare. More...

#include <mapsquare_walkable.h>

Inheritance diagram for mapsquare_walkable:

Public Member Functions

 mapsquare_walkable ()
 Default constructor. More...
 
s_int8 get (igzstream &file)
 Loads a mapsquare_walkable from an opened file. More...
 
s_int8 put (ogzstream &file) const
 Puts a mapsquare_walkable into an opened file. More...
 
bool is_walkable_west () const
 Returns whether a mapsquare is walkable from west. More...
 
bool is_walkable_east () const
 Returns whether a mapsquare is walkable from east. More...
 
bool is_walkable_north () const
 Returns whether a mapsquare is walkable from north. More...
 
bool is_walkable_south () const
 Returns whether a mapsquare is walkable from south. More...
 
void set_walkable_west (bool w)
 Sets the reachability from west of a mapsquare. More...
 
void set_walkable_east (bool w)
 Sets the reachability from east of a mapsquare. More...
 
void set_walkable_north (bool w)
 Sets the reachability from north of a mapsquare. More...
 
void set_walkable_south (bool w)
 Sets the reachability from south of a mapsquare. More...
 
u_int8 get_walkable () const
 Gets the raw walkable parameter of a mapsquare. More...
 
void set_walkable (u_int8 w)
 Sets the walkable parameter of a mapsquare. More...
 

Detailed Description

Contains information about the walkability of a mapsquare.

Definition at line 86 of file mapsquare_walkable.h.

Constructor & Destructor Documentation

◆ mapsquare_walkable()

mapsquare_walkable::mapsquare_walkable ( )

Default constructor.

Definition at line 30 of file mapsquare_walkable.cc.

Member Function Documentation

◆ get()

s_int8 mapsquare_walkable::get ( igzstream file)

Loads a mapsquare_walkable from an opened file.

Parameters
filethe file to load from.
Returns
0 in case of success, error code otherwise.

Definition at line 35 of file mapsquare_walkable.cc.

◆ put()

s_int8 mapsquare_walkable::put ( ogzstream file) const

Puts a mapsquare_walkable into an opened file.

Parameters
filethe file where to save.
Returns
0 in case of success, error code otherwise.

Definition at line 41 of file mapsquare_walkable.cc.

◆ is_walkable_west()

bool mapsquare_walkable::is_walkable_west ( ) const
inline

Returns whether a mapsquare is walkable from west.

Returns
true if the mapsquare is walkable from west, false otherwise.

Definition at line 120 of file mapsquare_walkable.h.

◆ is_walkable_east()

bool mapsquare_walkable::is_walkable_east ( ) const
inline

Returns whether a mapsquare is walkable from east.

Returns
true if the mapsquare is walkable from east, false otherwise.

Definition at line 131 of file mapsquare_walkable.h.

◆ is_walkable_north()

bool mapsquare_walkable::is_walkable_north ( ) const
inline

Returns whether a mapsquare is walkable from north.

Returns
true if the mapsquare is walkable from north, false otherwise.

Definition at line 142 of file mapsquare_walkable.h.

◆ is_walkable_south()

bool mapsquare_walkable::is_walkable_south ( ) const
inline

Returns whether a mapsquare is walkable from south.

Returns
true if the mapsquare is walkable from south, false otherwise.

Definition at line 153 of file mapsquare_walkable.h.

◆ set_walkable_west()

void mapsquare_walkable::set_walkable_west ( bool  w)
inline

Sets the reachability from west of a mapsquare.

Parameters
wtrue if the mapsquare should be reachable from west, false otherwise.

Definition at line 163 of file mapsquare_walkable.h.

◆ set_walkable_east()

void mapsquare_walkable::set_walkable_east ( bool  w)
inline

Sets the reachability from east of a mapsquare.

Parameters
wtrue if the mapsquare should be reachable from east, false otherwise.

Definition at line 176 of file mapsquare_walkable.h.

◆ set_walkable_north()

void mapsquare_walkable::set_walkable_north ( bool  w)
inline

Sets the reachability from north of a mapsquare.

Parameters
wtrue if the mapsquare should be reachable from north, false otherwise.

Definition at line 189 of file mapsquare_walkable.h.

◆ set_walkable_south()

void mapsquare_walkable::set_walkable_south ( bool  w)
inline

Sets the reachability from south of a mapsquare.

Parameters
wtrue if the mapsquare should be reachable from south, false otherwise.

Definition at line 202 of file mapsquare_walkable.h.

◆ get_walkable()

u_int8 mapsquare_walkable::get_walkable ( ) const
inline

Gets the raw walkable parameter of a mapsquare.

Returns
walkable parameter of this mapsquare.

Definition at line 215 of file mapsquare_walkable.h.

◆ set_walkable()

void mapsquare_walkable::set_walkable ( u_int8  w)
inline

Sets the walkable parameter of a mapsquare.

Parameters
wnew walkable status.

Definition at line 225 of file mapsquare_walkable.h.


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