Area of mapsquare_walkables, for use with mapcharacter and mapobject classes. More...

#include <mapsquare_walkable.h>

Inheritance diagram for mapsquare_walkable_area:

[legend]

Collaboration diagram for mapsquare_walkable_area:

Public Member Functions
	mapsquare_walkable_area ()
	Default constructor. More...

	~mapsquare_walkable_area ()
	Destructor. More...

void	clear ()
	Totally clears the area. More...

virtual void	draw (s_int16 x, s_int16 y, const drawing_area da_opt=NULL, surface target=NULL) const =0
	Draw the object on the screen. More...

Area settings.
u_int16	area_length () const
	Returns the length of the area. More...

u_int16	area_height () const
	Returns the height of the area. More...

mapsquare_walkable *	get_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...

Public Member Functions inherited from drawable
	drawable ()
	Default constructor. More...

virtual	~drawable ()
	Destructor. More...

u_int16	length () const
	Returns the length of the drawable. More...

u_int16	height () const
	Returns the height of the drawable. More...

virtual bool	update ()
	Virtual update function, provided for objects which doesn't need one. More...

virtual bool	input_update ()
	Virtual input update function, provided for objects which doesn't need one. More...

Base square settings.
u_int16	base_x () const
	Returns the X offset of the base square of this object. More...

u_int16	base_y () const
	Returns the Y offset of the base square of this object. More...

void	set_base (u_int16 nx, u_int16 ny)
	Sets the base square of this object. More...

s_int8	get (igzstream &file)
	Loads an area from an opened file. More...

s_int8	put (ogzstream &file) const
	Saves an area into an opened file. More...

mapsquare_walkable_area &	operator= (const mapsquare_walkable_area &mo)
	Area copy (similar to copy ()). More...

void	copy (const mapsquare_walkable_area &src)
	Synonym of operator = to guarantee its access from Python. More...

Additional Inherited Members
Protected Member Functions inherited from drawable
void	set_length (u_int16 l)
	Sets the length of the drawable. More...

void	set_height (u_int16 h)
	Sets the height of the drawable. More...

Detailed Description

Area of mapsquare_walkables, for use with mapcharacter and mapobject classes.

Definition at line 239 of file mapsquare_walkable.h.

Constructor & Destructor Documentation

◆ mapsquare_walkable_area()

mapsquare_walkable_area::mapsquare_walkable_area ( )

Default constructor.

Definition at line 47 of file mapsquare_walkable.cc.

◆ ~mapsquare_walkable_area()

mapsquare_walkable_area::~mapsquare_walkable_area ( )

Destructor.

Definition at line 53 of file mapsquare_walkable.cc.

Member Function Documentation

◆ clear()

void mapsquare_walkable_area::clear ( )

Totally clears the area.

Definition at line 57 of file mapsquare_walkable.cc.

◆ draw()

virtual void mapsquare_walkable_area::draw	(	s_int16	x,
		s_int16	y,
		const drawing_area *	da_opt = `NULL`,
		surface *	target = `NULL`
	)		const

pure virtual

Draw the object on the screen.

Parameters

x	X position where to draw.
y	Y position where to draw.
da_opt	optional drawing_area to use during the drawing operation.
target	pointer to the surface where to draw the drawable. If NULL, draw on the screen.

Implements drawable.

Implemented in mapcharacter, and mapobject.

◆ area_length()

u_int16 mapsquare_walkable_area::area_length ( ) const

inline

Returns the length of the area.

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

Definition at line 275 of file mapsquare_walkable.h.

◆ area_height()

u_int16 mapsquare_walkable_area::area_height ( ) const

inline

Returns the height of the area.

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

Definition at line 286 of file mapsquare_walkable.h.

◆ get_square()

mapsquare_walkable* mapsquare_walkable_area::get_square	(	u_int16	x,
		u_int16	y
	)		const

inline

Returns a pointer to a desired square.

Parameters

x	X position of the square to get.
y	Y position of the square to get.

Returns: pointer to the (x,y) square.

Definition at line 300 of file mapsquare_walkable.h.

◆ resize_area()

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

Resize the area.

Parameters

nl	new length (in number of squares) of the area.
nh	new height (in number of squares) of the area.

Definition at line 111 of file mapsquare_walkable.cc.

◆ base_x()

u_int16 mapsquare_walkable_area::base_x ( ) const

inline

Returns the X offset of the base square of this object.

Returns: X offset of the base square.

Definition at line 328 of file mapsquare_walkable.h.

◆ base_y()

u_int16 mapsquare_walkable_area::base_y ( ) const

inline

Returns the Y offset of the base square of this object.

Returns: Y offset of the base square.

Definition at line 339 of file mapsquare_walkable.h.

◆ set_base()

void mapsquare_walkable_area::set_base	(	u_int16	nx,
		u_int16	ny
	)

Sets the base square of this object.

Parameters

nx	X offset of the new base square.
ny	Y offset of the new base square.

Definition at line 123 of file mapsquare_walkable.cc.

◆ get()

s_int8 mapsquare_walkable_area::get ( igzstream & file )

Loads an area from an opened file.

Parameters

file	the opened file from which to load.

Returns: 0 in case of success, error code otherwise.

Definition at line 65 of file mapsquare_walkable.cc.

◆ put()

s_int8 mapsquare_walkable_area::put ( ogzstream & file ) const

Saves an area into an opened file.

Parameters

file	the opened file where to write.

Returns: 0 in case of success, error code otherwise.

Definition at line 90 of file mapsquare_walkable.cc.

◆ operator=()

mapsquare_walkable_area & mapsquare_walkable_area::operator= ( const mapsquare_walkable_area & mo )

Area copy (similar to copy ()).

Attention: Not available from Python. Use copy () from Python instead.

See also: copy ()

Definition at line 129 of file mapsquare_walkable.cc.

◆ copy()

void mapsquare_walkable_area::copy ( const mapsquare_walkable_area & src )

inline

Synonym of operator = to guarantee its access from Python.

See also: operator =

Definition at line 385 of file mapsquare_walkable.h.

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

Public Member Functions

Base square settings.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ mapsquare_walkable_area()

◆ ~mapsquare_walkable_area()

Member Function Documentation

◆ clear()

◆ draw()

◆ area_length()

◆ area_height()

◆ get_square()

◆ resize_area()

◆ base_x()

◆ base_y()

◆ set_base()

◆ get()

◆ put()

◆ operator=()

◆ copy()