ScummVM API documentation
Ultima::Ultima3::LocationLogic Class Reference

#include <location_logic.h>

Inheritance diagram for Ultima::Ultima3::LocationLogic:
Ultima::Ultima3::Logic

Public Types

enum  ExitResult { EXIT_NOT_RIDING , EXIT_NOT_HERE , EXIT_DONE }
 

Public Member Functions

bool move (Direction dir)
 
void teleportRandomly ()
 
void updateMoons ()
 
void setMoonPhases (byte left, byte right)
 
bool isOnMoonGate () const
 
bool isInExodusCastle () const
 
void teleportThroughMoonGate ()
 
bool isOnWhirlpool () const
 
bool updateWhirlpool ()
 
void teleportToAmbrosia ()
 
const char * board ()
 
ExitResult exitVehicle ()
 
const char * enter ()
 
const char * enterLocation (int index)
 
bool isAtExit () const
 
void exitToWorld ()
 
- Public Member Functions inherited from Ultima::Ultima3::Logic
void incrementMoveCounter (int amount=-1)
 
void processPartyTurnEffects (bool everyTurn)
 
bool damageCharacter (int slot, int amount)
 

Static Public Member Functions

static int entranceCount ()
 
static const char * entranceFilename (int index)
 
static Common::Point entrancePosition (int index)
 

Detailed Description

Rules for moving the party around a map

Member Function Documentation

◆ move()

bool Ultima::Ultima3::LocationLogic::move ( Direction  dir)

Moves the party a step in a direction, if they can

Returns
True if they moved

◆ teleportRandomly()

void Ultima::Ultima3::LocationLogic::teleportRandomly ( )

Moves the party to a random place on the world map

◆ updateMoons()

void Ultima::Ultima3::LocationLogic::updateMoons ( )

Moves the moons on a turn, and the moon gate to where they say

◆ setMoonPhases()

void Ultima::Ultima3::LocationLogic::setMoonPhases ( byte  left,
byte  right 
)

Puts the moons in the given phases, and the moon gate and Dawn where they say

◆ isInExodusCastle()

bool Ultima::Ultima3::LocationLogic::isInExodusCastle ( ) const

Returns true if the party is in the castle of Exodus

◆ teleportThroughMoonGate()

void Ultima::Ultima3::LocationLogic::teleportThroughMoonGate ( )

Moves the party from a moon gate to the one the moons lead to

◆ updateWhirlpool()

bool Ultima::Ultima3::LocationLogic::updateWhirlpool ( )

Lets the whirlpool of the sea drift on a step

Returns
True if it has come upon the party

◆ teleportToAmbrosia()

void Ultima::Ultima3::LocationLogic::teleportToAmbrosia ( )

Takes the ship of the party to Ambrosia in a whirlpool, or brings them back from there

◆ board()

const char * Ultima::Ultima3::LocationLogic::board ( )

Mounts a horse or boards a ship that the party is standing on

Returns
What to say about it, or null if there's nothing to board

◆ exitVehicle()

ExitResult Ultima::Ultima3::LocationLogic::exitVehicle ( )

Gets off a horse or ship, leaving it behind

◆ enter()

const char * Ultima::Ultima3::LocationLogic::enter ( )

Takes the party into the town or castle they're standing at the entrance to

Returns
What to say about it, or null if there's nowhere to enter

◆ enterLocation()

const char * Ultima::Ultima3::LocationLogic::enterLocation ( int  index)

Takes the party into one of the places that have an entrance on the world map, wherever they are on it

Returns
What to say about it, or null if it can't be entered

◆ entranceCount()

static int Ultima::Ultima3::LocationLogic::entranceCount ( )
static

Returns details of the places that have an entrance on the world map

◆ isAtExit()

bool Ultima::Ultima3::LocationLogic::isAtExit ( ) const

Returns true if the party has reached the edge of a town or castle, and so leaves it

◆ exitToWorld()

void Ultima::Ultima3::LocationLogic::exitToWorld ( )

Takes the party back out onto the world map


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