hoa_map::private_map Namespace Reference

An internal namespace to be used only within the map code. Don't use this namespace anywhere else! More...


Classes

class  ActionAnimate
 Action that displays specific sprite frames for a certain period of time. More...
class  ActionPathMove
 Action involving movement between a source and destination tile. More...
class  ActionRandomMove
 Action for declaring random movement of sprites. More...
class  DialogueManager
 A display for managing and displaying dialogue on maps. More...
class  EnemySprite
 A mobile map object that induces a battle to occur if the player touches it. More...
class  EnemyZone
 Class that represents an area where enemies spawn and roam in. More...
class  MapDialogue
 Retains and manages dialogues between characters on a map. More...
class  MapFrame
 Retains information about how the next map frame should be drawn. More...
class  MapObject
 Abstract class that represents objects on a map. More...
struct  MapObject_Ptr_Less
 This is a predicate used to sort MapObjects in correct draw order. More...
class  MapSprite
 A mobile map object with which the player can interact with. More...
class  MapZone
 A class that represents a special zone on a map. More...
class  PathNode
 A container class for node information in pathfinding. More...
class  PhysicalObject
 Represents visible objects on the map that have no motion. More...
class  SpriteAction
 An abstract class for sprite actions. More...
class  VirtualSprite
 An invisible and possible mobile sprite on a map. More...
class  ZoneSection
 Class that represents a rectangular area on a map. More...

Enumerations

Map Context Constants
Constants used to represent all 32 possible map contexts

enum  MAP_CONTEXT {
  MAP_CONTEXT_01 = 0x00000001, MAP_CONTEXT_02 = 0x00000002, MAP_CONTEXT_03 = 0x00000004, MAP_CONTEXT_04 = 0x00000008,
  MAP_CONTEXT_05 = 0x00000010, MAP_CONTEXT_06 = 0x00000020, MAP_CONTEXT_07 = 0x00000040, MAP_CONTEXT_08 = 0x00000080,
  MAP_CONTEXT_09 = 0x00000100, MAP_CONTEXT_10 = 0x00000200, MAP_CONTEXT_11 = 0x00000400, MAP_CONTEXT_12 = 0x00000800,
  MAP_CONTEXT_13 = 0x00001000, MAP_CONTEXT_14 = 0x00002000, MAP_CONTEXT_15 = 0x00004000, MAP_CONTEXT_16 = 0x00008000,
  MAP_CONTEXT_17 = 0x00010000, MAP_CONTEXT_18 = 0x00020000, MAP_CONTEXT_19 = 0x00040000, MAP_CONTEXT_20 = 0x00080000,
  MAP_CONTEXT_21 = 0x00100000, MAP_CONTEXT_22 = 0x00200000, MAP_CONTEXT_23 = 0x00400000, MAP_CONTEXT_24 = 0x00800000,
  MAP_CONTEXT_25 = 0x01000000, MAP_CONTEXT_26 = 0x02000000, MAP_CONTEXT_27 = 0x04000000, MAP_CONTEXT_28 = 0x08000000,
  MAP_CONTEXT_29 = 0x10000000, MAP_CONTEXT_30 = 0x20000000, MAP_CONTEXT_31 = 0x40000000, MAP_CONTEXT_32 = 0x80000000
}

Variables

const int32 DIALOGUE_INFINITE = -1
 This constant is used to indicate that a line of dialogue can stay an infinite time on the screen.
hoa_video::AnimatedImage new_dialogue_icon
 An animated icon used to indicate which sprites have unseen dialogue.
hoa_video::AnimatedImage new_dialogue_icon
 An animated icon used to indicate which sprites have unseen dialogue.
const uint32 TILES_PER_TILESET = 256
 The number of tiles that are found in a tileset image (512x512 pixel image containing 32x32 pixel tiles).
Map Sprite Animation Constants
These constants are used to index the MapSprite::animations vector to display the correct animation. The first 8 entries in this vector always represent the same sets of animations for each map sprite.

const uint32 ANIM_STANDING_EAST = 3
const uint32 ANIM_STANDING_NORTH = 1
const uint32 ANIM_STANDING_SOUTH = 0
const uint32 ANIM_STANDING_WEST = 2
const uint32 ANIM_WALKING_EAST = 7
const uint32 ANIM_WALKING_NORTH = 5
const uint32 ANIM_WALKING_SOUTH = 4
const uint32 ANIM_WALKING_WEST = 6
Map State Constants
Constants used for describing the current state of operation during map mode. These constants are largely used to determine what

const uint8 DIALOGUE = 0x02
 When a dialogue is in process, the map is in this state.
const uint8 EXPLORE = 0x01
 The standard state of the map, where the player is free to roam.
const uint8 OBSERVATION = 0x04
 When the map is in this state, the player can not control the action.
Sprite Direction Constants
Constants used for setting and determining sprite directions Sprites are allowed to travel in eight different directions, however the sprite itself can only be facing one of four ways: north, south, east, or west. Because of this, it is possible to travel, for instance, northwest facing north or northwest facing west. The "NW_NORTH" constant means that the sprite is traveling to the northwest and is facing towards the north.

Note:
The set of "FACING_DIRECTION" and "MOVING_DIRECTION" constants are only meant to be used as shorthands. You shouldn't assign the MapSprite::direction member to any of these values.


const uint16 EAST = 0x0008
const uint16 FACING_EAST = EAST | NE_EAST | SE_EAST
const uint16 FACING_NORTH = NORTH | NW_NORTH | NE_NORTH
const uint16 FACING_SOUTH = SOUTH | SW_SOUTH | SE_SOUTH
const uint16 FACING_WEST = WEST | NW_WEST | SW_WEST
const uint16 NE_EAST = 0x0080
const uint16 NE_NORTH = 0x0040
const uint16 NORTH = 0x0001
const uint16 NORTHEAST = NE_NORTH | NE_EAST
const uint16 NORTHWEST = NW_NORTH | NW_WEST
const uint16 NW_NORTH = 0x0010
const uint16 NW_WEST = 0x0020
const uint16 SE_EAST = 0x0800
const uint16 SE_SOUTH = 0x0400
const uint16 SOUTH = 0x0002
const uint16 SOUTHEAST = SE_SOUTH | SE_EAST
const uint16 SOUTHWEST = SW_SOUTH | SW_WEST
const uint16 SW_SOUTH = 0x0100
const uint16 SW_WEST = 0x0200
const uint16 WEST = 0x0004
Map Object Type Constants
These constants are used to identify the type of map object or sprite.

const uint8 ENEMY_TYPE = 3
const uint8 PHYSICAL_TYPE = 0
const uint8 SPRITE_TYPE = 2
const uint8 VIRTUAL_TYPE = 1
Map Sprite Speeds
Common speeds for sprite movement. These values are the time (in milliseconds) that it takes a sprite to walk the distance of one map grid (16 pixels).

const float FAST_SPEED = 125.0f
const float NORMAL_SPEED = 150.0f
const float SLOW_SPEED = 175.0f
const float VERY_FAST_SPEED = 100.0f
const float VERY_SLOW_SPEED = 200.0f
Screen Coordiante System Constants
The number of rows and columns of map grid elements that compose the screen. These are not the number of tiles that compose the screen. The number of tile rows and columns that compose a screen are exactly one half of these numbers.

const float HALF_SCREEN_COLS = 32.0f
const float HALF_SCREEN_ROWS = 24.0f
const uint16 HALF_TILE_COLS = 16
const uint16 HALF_TILE_ROWS = 12
const float SCREEN_COLS = 64.0f
const float SCREEN_ROWS = 48.0f
const uint16 TILE_COLS = 32
const uint16 TILE_ROWS = 24


Detailed Description

An internal namespace to be used only within the map code. Don't use this namespace anywhere else!

Enumeration Type Documentation

enum hoa_map::private_map::MAP_CONTEXT

Enumerator:
MAP_CONTEXT_01 
MAP_CONTEXT_02 
MAP_CONTEXT_03 
MAP_CONTEXT_04 
MAP_CONTEXT_05 
MAP_CONTEXT_06 
MAP_CONTEXT_07 
MAP_CONTEXT_08 
MAP_CONTEXT_09 
MAP_CONTEXT_10 
MAP_CONTEXT_11 
MAP_CONTEXT_12 
MAP_CONTEXT_13 
MAP_CONTEXT_14 
MAP_CONTEXT_15 
MAP_CONTEXT_16 
MAP_CONTEXT_17 
MAP_CONTEXT_18 
MAP_CONTEXT_19 
MAP_CONTEXT_20 
MAP_CONTEXT_21 
MAP_CONTEXT_22 
MAP_CONTEXT_23 
MAP_CONTEXT_24 
MAP_CONTEXT_25 
MAP_CONTEXT_26 
MAP_CONTEXT_27 
MAP_CONTEXT_28 
MAP_CONTEXT_29 
MAP_CONTEXT_30 
MAP_CONTEXT_31 
MAP_CONTEXT_32 

Definition at line 83 of file map.h.


Variable Documentation

const uint32 hoa_map::private_map::ANIM_STANDING_EAST = 3

Definition at line 91 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_map::private_map::MapSprite::Update().

const uint32 hoa_map::private_map::ANIM_STANDING_NORTH = 1

Definition at line 89 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_map::private_map::MapSprite::Update().

const uint32 hoa_map::private_map::ANIM_STANDING_SOUTH = 0

Definition at line 88 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_map::private_map::MapSprite::Update().

const uint32 hoa_map::private_map::ANIM_STANDING_WEST = 2

Definition at line 90 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_map::private_map::MapSprite::Update().

const uint32 hoa_map::private_map::ANIM_WALKING_EAST = 7

Definition at line 95 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_map::private_map::MapSprite::Update().

const uint32 hoa_map::private_map::ANIM_WALKING_NORTH = 5

Definition at line 93 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_map::private_map::MapSprite::Update().

const uint32 hoa_map::private_map::ANIM_WALKING_SOUTH = 4

Definition at line 92 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_map::private_map::MapSprite::Update().

const uint32 hoa_map::private_map::ANIM_WALKING_WEST = 6

Definition at line 94 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_map::private_map::MapSprite::Update().

const uint8 hoa_map::private_map::DIALOGUE = 0x02

When a dialogue is in process, the map is in this state.

Definition at line 75 of file map.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_defs::BindEngineToLua(), hoa_map::MapMode::Draw(), and hoa_map::MapMode::Update().

const int32 hoa_map::private_map::DIALOGUE_INFINITE = -1

This constant is used to indicate that a line of dialogue can stay an infinite time on the screen.

Definition at line 28 of file map_dialogue.h.

Referenced by hoa_defs::BindEngineToLua().

const uint16 hoa_map::private_map::EAST = 0x0008

Definition at line 61 of file map_sprites.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::ActionPathMove::Execute(), hoa_map::private_map::VirtualSprite::SetDirection(), hoa_map::private_map::VirtualSprite::SetRandomDirection(), hoa_map::private_map::EnemySprite::Update(), and hoa_map::private_map::VirtualSprite::Update().

const uint8 hoa_map::private_map::ENEMY_TYPE = 3

Definition at line 35 of file map_objects.h.

Referenced by hoa_map::private_map::EnemySprite::EnemySprite().

const uint8 hoa_map::private_map::EXPLORE = 0x01

The standard state of the map, where the player is free to roam.

Definition at line 73 of file map.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_map::private_map::DialogueManager::Update(), and hoa_map::MapMode::Update().

const uint16 hoa_map::private_map::FACING_EAST = EAST | NE_EAST | SE_EAST

Definition at line 79 of file map_sprites.h.

Referenced by hoa_map::MapMode::_FindNearestObject(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::MapSprite::Update().

const uint16 hoa_map::private_map::FACING_NORTH = NORTH | NW_NORTH | NE_NORTH

Definition at line 76 of file map_sprites.h.

Referenced by hoa_map::MapMode::_FindNearestObject(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::MapSprite::Update().

const uint16 hoa_map::private_map::FACING_SOUTH = SOUTH | SW_SOUTH | SE_SOUTH

Definition at line 77 of file map_sprites.h.

Referenced by hoa_map::MapMode::_FindNearestObject(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::MapSprite::Update().

const uint16 hoa_map::private_map::FACING_WEST = WEST | NW_WEST | SW_WEST

Definition at line 78 of file map_sprites.h.

Referenced by hoa_map::MapMode::_FindNearestObject(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::MapSprite::Update().

const float hoa_map::private_map::FAST_SPEED = 125.0f

Definition at line 42 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua().

const float hoa_map::private_map::HALF_SCREEN_COLS = 32.0f

Definition at line 56 of file map.h.

Referenced by hoa_map::MapMode::_CalculateDrawInfo().

const float hoa_map::private_map::HALF_SCREEN_ROWS = 24.0f

Definition at line 57 of file map.h.

Referenced by hoa_map::MapMode::_CalculateDrawInfo().

const uint16 hoa_map::private_map::HALF_TILE_COLS = 16

Definition at line 60 of file map.h.

Referenced by hoa_map::MapMode::_CalculateDrawInfo().

const uint16 hoa_map::private_map::HALF_TILE_ROWS = 12

Definition at line 61 of file map.h.

Referenced by hoa_map::MapMode::_CalculateDrawInfo().

const uint16 hoa_map::private_map::NE_EAST = 0x0080

Definition at line 65 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::VirtualSprite::Update().

const uint16 hoa_map::private_map::NE_NORTH = 0x0040

Definition at line 64 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::VirtualSprite::Update().

hoa_video::AnimatedImage hoa_map::private_map::new_dialogue_icon

An animated icon used to indicate which sprites have unseen dialogue.

Definition at line 42 of file map_sprites.cpp.

Referenced by hoa_map::private_map::VirtualSprite::Draw(), and hoa_map::private_map::VirtualSprite::Update().

hoa_video::AnimatedImage hoa_map::private_map::new_dialogue_icon

An animated icon used to indicate which sprites have unseen dialogue.

Definition at line 42 of file map_sprites.cpp.

Referenced by hoa_map::private_map::VirtualSprite::Draw(), and hoa_map::private_map::VirtualSprite::Update().

const float hoa_map::private_map::NORMAL_SPEED = 150.0f

Definition at line 41 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua().

const uint16 hoa_map::private_map::NORTH = 0x0001

Definition at line 58 of file map_sprites.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::ActionPathMove::Execute(), hoa_map::private_map::VirtualSprite::SetDirection(), hoa_map::private_map::VirtualSprite::SetRandomDirection(), hoa_map::private_map::EnemySprite::Update(), and hoa_map::private_map::VirtualSprite::Update().

const uint16 hoa_map::private_map::NORTHEAST = NE_NORTH | NE_EAST

Definition at line 72 of file map_sprites.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_map::private_map::ActionPathMove::Execute(), hoa_map::private_map::VirtualSprite::SetDirection(), hoa_map::private_map::VirtualSprite::SetRandomDirection(), and hoa_map::private_map::EnemySprite::Update().

const uint16 hoa_map::private_map::NORTHWEST = NW_NORTH | NW_WEST

Definition at line 71 of file map_sprites.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_map::private_map::ActionPathMove::Execute(), hoa_map::private_map::VirtualSprite::SetDirection(), hoa_map::private_map::VirtualSprite::SetRandomDirection(), and hoa_map::private_map::EnemySprite::Update().

const uint16 hoa_map::private_map::NW_NORTH = 0x0010

Definition at line 62 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::VirtualSprite::Update().

const uint16 hoa_map::private_map::NW_WEST = 0x0020

Definition at line 63 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::VirtualSprite::Update().

const uint8 hoa_map::private_map::OBSERVATION = 0x04

When the map is in this state, the player can not control the action.

Definition at line 77 of file map.h.

Referenced by hoa_defs::BindEngineToLua().

const uint8 hoa_map::private_map::PHYSICAL_TYPE = 0

Definition at line 32 of file map_objects.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_map::private_map::PhysicalObject::PhysicalObject().

const float hoa_map::private_map::SCREEN_COLS = 64.0f

Definition at line 54 of file map.h.

Referenced by hoa_map::MapMode::_CalculateDrawInfo(), and hoa_map::MapMode::Reset().

const float hoa_map::private_map::SCREEN_ROWS = 48.0f

Definition at line 55 of file map.h.

Referenced by hoa_map::MapMode::_CalculateDrawInfo(), and hoa_map::MapMode::Reset().

const uint16 hoa_map::private_map::SE_EAST = 0x0800

Definition at line 69 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::VirtualSprite::Update().

const uint16 hoa_map::private_map::SE_SOUTH = 0x0400

Definition at line 68 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::VirtualSprite::Update().

const float hoa_map::private_map::SLOW_SPEED = 175.0f

Definition at line 40 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua().

const uint16 hoa_map::private_map::SOUTH = 0x0002

Definition at line 59 of file map_sprites.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::ActionPathMove::Execute(), hoa_map::private_map::VirtualSprite::SetDirection(), hoa_map::private_map::VirtualSprite::SetRandomDirection(), hoa_map::private_map::EnemySprite::Update(), and hoa_map::private_map::VirtualSprite::Update().

const uint16 hoa_map::private_map::SOUTHEAST = SE_SOUTH | SE_EAST

Definition at line 74 of file map_sprites.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_map::private_map::ActionPathMove::Execute(), hoa_map::private_map::VirtualSprite::SetDirection(), hoa_map::private_map::VirtualSprite::SetRandomDirection(), and hoa_map::private_map::EnemySprite::Update().

const uint16 hoa_map::private_map::SOUTHWEST = SW_SOUTH | SW_WEST

Definition at line 73 of file map_sprites.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_map::private_map::ActionPathMove::Execute(), hoa_map::private_map::VirtualSprite::SetDirection(), hoa_map::private_map::VirtualSprite::SetRandomDirection(), and hoa_map::private_map::EnemySprite::Update().

const uint8 hoa_map::private_map::SPRITE_TYPE = 2

Definition at line 34 of file map_objects.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_defs::BindEngineToLua(), and hoa_map::private_map::MapSprite::MapSprite().

const uint16 hoa_map::private_map::SW_SOUTH = 0x0100

Definition at line 66 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::VirtualSprite::Update().

const uint16 hoa_map::private_map::SW_WEST = 0x0200

Definition at line 67 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::VirtualSprite::SetDirection(), and hoa_map::private_map::VirtualSprite::Update().

const uint16 hoa_map::private_map::TILE_COLS = 32

Definition at line 58 of file map.h.

Referenced by hoa_map::MapMode::_CalculateDrawInfo().

const uint16 hoa_map::private_map::TILE_ROWS = 24

Definition at line 59 of file map.h.

Referenced by hoa_map::MapMode::_CalculateDrawInfo().

const uint32 hoa_map::private_map::TILES_PER_TILESET = 256

The number of tiles that are found in a tileset image (512x512 pixel image containing 32x32 pixel tiles).

Definition at line 65 of file map.h.

Referenced by hoa_map::MapMode::_LoadTiles().

const float hoa_map::private_map::VERY_FAST_SPEED = 100.0f

Definition at line 43 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua().

const float hoa_map::private_map::VERY_SLOW_SPEED = 200.0f

Definition at line 39 of file map_sprites.h.

Referenced by hoa_defs::BindEngineToLua().

const uint8 hoa_map::private_map::VIRTUAL_TYPE = 1

Definition at line 33 of file map_objects.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_defs::BindEngineToLua(), and hoa_map::private_map::VirtualSprite::VirtualSprite().

const uint16 hoa_map::private_map::WEST = 0x0004

Definition at line 60 of file map_sprites.h.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_defs::BindEngineToLua(), hoa_map::private_map::VirtualSprite::CalculateOppositeDirection(), hoa_map::private_map::ActionPathMove::Execute(), hoa_map::private_map::VirtualSprite::SetDirection(), hoa_map::private_map::VirtualSprite::SetRandomDirection(), hoa_map::private_map::EnemySprite::Update(), and hoa_map::private_map::VirtualSprite::Update().


Generated on Fri Jul 6 23:14:41 2007 for Hero of Allacrost by  doxygen 1.5.1