Amulets & Armor  v1.02
Open Source Game
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Macros | Functions
OVERHEAD

Overhead Map. More...

Macros

#define INTERNAL_MAX_OFFSET_X   320
 
#define INTERNAL_MAX_OFFSET_Y   200
 
#define INTERNAL_MAX_SIZE_X   320
 
#define INTERNAL_MAX_SIZE_Y   200
 
#define OVERHEAD_PASSIBLE_LINE   47
 
#define OVERHEAD_SOLID_LINE   31
 

Functions

T_void OverheadAddFeatures (F_overheadFeature flags)
 
T_void OverheadDraw (T_word16 left, T_word16 top, T_word16 right, T_word16 bottom)
 
T_void OverheadFinish (T_void)
 
F_overheadFeature OverheadGetFeatures (T_void)
 
T_word16 OverheadGetOffsetX (T_void)
 
T_word16 OverheadGetOffsetY (T_void)
 
E_overheadPosition OverheadGetPosition (T_void)
 
T_word16 OverheadGetSizeX (T_void)
 
T_word16 OverheadGetSizeY (T_void)
 
T_word32 OverheadGetZoomFactor (T_void)
 
T_void OverheadInitialize (T_void)
 
E_Boolean OverheadIsOn (T_void)
 
T_void OverheadOff (T_void)
 
T_void OverheadOn (T_void)
 
T_void OverheadRemoveFeatures (F_overheadFeature flags)
 
T_void OverheadSetCenterPoint (T_sword32 x, T_sword32 y)
 
T_void OverheadSetFeatures (F_overheadFeature flags)
 
T_void OverheadSetNumPages (void)
 
T_void OverheadSetOffset (T_word16 offsetX, T_word16 offsetY)
 
T_void OverheadSetPosition (E_overheadPosition position)
 
T_void OverheadSetSize (T_word16 sizeX, T_word16 sizeY)
 
T_void OverheadSetZoomFactor (T_word32 zoom)
 
T_void OverheadToggle (T_void)
 

Detailed Description

Overhead Map.

The Overhead or "Magic" map is rendered here. Various options turn on features to show secret areas or even objects.

See Also
http://www.amuletsandarmor.com/AALicense.txt

Macro Definition Documentation

#define INTERNAL_MAX_OFFSET_X   320
#define INTERNAL_MAX_OFFSET_Y   200
#define INTERNAL_MAX_SIZE_X   320
#define INTERNAL_MAX_SIZE_Y   200
#define OVERHEAD_PASSIBLE_LINE   47
#define OVERHEAD_SOLID_LINE   31

Function Documentation

T_void OverheadAddFeatures ( F_overheadFeature  flags)

OverheadAddFeatures turns on some of the features being used.

Parameters
flags– Flags to be added
T_void OverheadDraw ( T_word16  left,
T_word16  top,
T_word16  right,
T_word16  bottom 
)

OverheadDraw is the heart of the overhead drawing. This routine is should be part of the 3d view callback routine and have the correct boundaries of the view.

Parameters
left– Left of allowed view
top– Top of allowed view
right– Right of allowed view
bottom– Bottom of allowed view
T_void OverheadFinish ( T_void  )

OverheadFinish undo's all the bad things remainging with the overhead.

F_overheadFeature OverheadGetFeatures ( T_void  )

OverheadGetFeatures gets all the features used by the overhead.

Returns
Current overhead flags.
T_word16 OverheadGetOffsetX ( T_void  )

OverheadGetOffsetX returns the number of pixels to place overhead away from the left or right edge.

Returns
Number pixels from left or right edge
T_word16 OverheadGetOffsetY ( T_void  )

OverheadGetOffsetY returns the number of pixels to place overhead away from the top or bottom edge.

Returns
Number pixels from top or bottom edge
E_overheadPosition OverheadGetPosition ( T_void  )

OverheadGetPosition tells where the overhead is placed relative to the view.

Returns
What location the overhead should be
T_word16 OverheadGetSizeX ( T_void  )

OverheadGetSizeX returns the width of the overhead view.

Returns
Width of the overhead view
T_word16 OverheadGetSizeY ( T_void  )

OverheadGetSizeY returns the height of the overhead view.

Returns
Height of the overhead view
T_word32 OverheadGetZoomFactor ( T_void  )

OverheadGetZoomFactor gets the scaling factor used when drawing the the view.

Returns
Zoom factor, smaller value is more detail.
T_void OverheadInitialize ( T_void  )

OverheadInitialize clears out all the memory that is needed for the first use of this module.

E_Boolean OverheadIsOn ( T_void  )

OverheadIsOn tells if overhead view is on.

T_void OverheadOff ( T_void  )

OverheadOff turns of the overhead view.

T_void OverheadOn ( T_void  )

OverheadOn turns on the overhead view.

T_void OverheadRemoveFeatures ( F_overheadFeature  flags)

OverheadRemoveFeatures turns off some of the features being used.

Parameters
flags– Flags to be cleared
T_void OverheadSetCenterPoint ( T_sword32  x,
T_sword32  y 
)

OverheadSetCenterPoint declares where the view should be centered over. This routine should be called before every call to OverheadDraw.

Parameters
x– X Point to center view over
y– Y Point to center view over
T_void OverheadSetFeatures ( F_overheadFeature  flags)

OverheadAddFeatures sets all the features to be used by the overhead.

Parameters
flags– Flags to be on
T_void OverheadSetNumPages ( void  )

OverheadSetNumPages changes the number of pages that are "smeared" together when drawing the overhead view.

NOTE: Changing the number of pages clears all the old pages.

T_void OverheadSetOffset ( T_word16  offsetX,
T_word16  offsetY 
)

OverheadSetOffset tells the overhead module how many pixels off the left or right (x) edge and how many pixels off the top or bottom (y) edge. The offset depends on the position of the view (see OverheadSetPosition).

Parameters
offsetX– Pixels off the left or right
offsetY– Pixels off the top or bottom
T_void OverheadSetPosition ( E_overheadPosition  position)

OverheadSetPosition tells where to place the overhead relative to the view.

Parameters
position– What location the overhead should be
T_void OverheadSetSize ( T_word16  sizeX,
T_word16  sizeY 
)

OverheadSetSize changes the height and width of the overhead view.

NOTE: Setting a new size clears any previous pages.

Parameters
sizeX– Width of overhead view
sizeY– Height of the overhead view
T_void OverheadSetZoomFactor ( T_word32  zoom)

OverheadSetZoomFactor sets the scaling factor used when drawing the the view.

Parameters
zoom– Zoom factor, smaller value is more detail.
T_void OverheadToggle ( T_void  )

OverheadToggle turns on the overview if it is off, and visa-versa.