ScummVM API documentation
MutationOfJB::Door Struct Reference

#include <gamedata.h>

Inheritance diagram for MutationOfJB::Door:
Common::Serializable

Public Member Functions

bool isActive ()
 
bool loadInitialState (Common::ReadStream &stream)
 
void saveLoadWithSerializer (Common::Serializer &sz) override
 
bool allowsImplicitSceneChange () const
 

Public Attributes

char _name [MAX_ENTITY_NAME_LENGTH+1]
 
uint8 _destSceneId
 
uint16 _destX
 
uint16 _destY
 
uint16 _x
 
uint8 _y
 
uint16 _width
 
uint8 _height
 
uint16 _walkToX
 
uint8 _walkToY
 
uint8 _SP
 

Detailed Description

An interactable scene changer with no visual representation.

Member Function Documentation

◆ isActive()

bool MutationOfJB::Door::isActive ( )

Check if this door can be interacted with.

Returns
True if this door can be interacted with, false otherwise.

◆ loadInitialState()

bool MutationOfJB::Door::loadInitialState ( Common::ReadStream stream)

Load initial state from game data file.

Parameters
streamStream for reading.
Returns
True if success, false otherwise.

◆ saveLoadWithSerializer()

void MutationOfJB::Door::saveLoadWithSerializer ( Common::Serializer sz)
overridevirtual

(De)serialization for save/load.

Parameters
szSerializer.

Implements Common::Serializable.

◆ allowsImplicitSceneChange()

bool MutationOfJB::Door::allowsImplicitSceneChange ( ) const

Check whether walk action used on this door causes implicit scene change.

Returns
True if door implicitly changes current scene, false otherwise.

Member Data Documentation

◆ _name

char MutationOfJB::Door::_name[MAX_ENTITY_NAME_LENGTH+1]

Door name (NM register).

Can be empty - deactivates door completely (you can't mouse over or interact with it at all).

If it ends with '+', using the "go" verb on the door will not implicitly change the scene, but the player will still walk towards the door.

◆ _destSceneId

uint8 MutationOfJB::Door::_destSceneId

Scene ID where the door leads (LT register). Can be 0 - you can hover your mouse over it, but clicking it doesn't do anything (unless scripted).

◆ _destX

uint16 MutationOfJB::Door::_destX

X coordinate for player's position after going through the door (SX register).

◆ _destY

uint16 MutationOfJB::Door::_destY

Y coordinate for player's position after going through the door (SY register).

◆ _x

uint16 MutationOfJB::Door::_x

X coordinate of the door rectangle (XX register).

◆ _y

uint8 MutationOfJB::Door::_y

Y coordinate of the door rectangle (YY register).

◆ _width

uint16 MutationOfJB::Door::_width

Width of the door rectangle (XL register).

◆ _height

uint8 MutationOfJB::Door::_height

Height of the door rectangle (YL register).

◆ _walkToX

uint16 MutationOfJB::Door::_walkToX

X coordinate for position player will walk towards after clicking the door (WX register).

◆ _walkToY

uint8 MutationOfJB::Door::_walkToY

Y coordinate for position player will walk towards after clicking the door (WY register).

◆ _SP

uint8 MutationOfJB::Door::_SP

Encoded player frames. 4 bits - destFrame 4 bits - walkToFrame


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