org.zmpp.vm
Interface StoryFileHeader

All Known Implementing Classes:

DefaultStoryFileHeader

public interface StoryFileHeader

This interface defines the structure of a story file header in the Z-machine. It is designed as a read only view to the byte array containing the story file data. By this means, changes in the memory map will be implicitly change the header structure.

Version:

1.0

Author:

Wei-ju Wu

Method Summary

int	getAbbreviationsAddress() Returns the start address of the abbreviations section.
int	getChecksum() Returns the checksum for the story file.
int	getDictionaryAddress() Returns the dictionary's start address.
int	getFileLength() Returns this story file's length.
int	getFlags1() Returns the flags1 field.
int	getFlags2() Returns the flags2 field.
int	getGlobalsAddress() Returns the address of the global variables.
int	getHighMemAddress() Returns the high memory start address.
int	getInterpreter() Returns the interpreter number.
int	getInterpreterVersion() Returns the interpreter version.
int	getObjectTableAddress() Returns the object table's start address.
int	getProgramStart() Returns the program counter start address.
int	getRelease() Returns the release number.
int	getRevision() Returns the revision number.
String	getSerialNumber() Returns this game's serial number.
int	getStaticsAddress() Returns the static memory start address.
int	getVersion() Returns the story file version.

Method Detail

getVersion

int getVersion()

Returns the story file version.

Returns:

the story file version

getFlags1

int getFlags1()

Returns the flags1 field.

Returns:

the flags1 field

getRelease

int getRelease()

Returns the release number.

Returns:

the release number

getHighMemAddress

int getHighMemAddress()

Returns the high memory start address.

Returns:

the start of the high memory

getProgramStart

int getProgramStart()

Returns the program counter start address.

Returns:

the PC start address

getDictionaryAddress

int getDictionaryAddress()

Returns the dictionary's start address.

Returns:

the dictionary start address

getObjectTableAddress

int getObjectTableAddress()

Returns the object table's start address.

Returns:

the object table's start address

getGlobalsAddress

int getGlobalsAddress()

Returns the address of the global variables.

Returns:

the global variables section

getStaticsAddress

int getStaticsAddress()

Returns the static memory start address.

Returns:

the start address of the static memory

getFlags2

int getFlags2()

Returns the flags2 field.

Returns:

the flags2 field

getSerialNumber

String getSerialNumber()

Returns this game's serial number.

Returns:

the serial number

getAbbreviationsAddress

int getAbbreviationsAddress()

Returns the start address of the abbreviations section.

Returns:

the abbreviations start address

getFileLength

int getFileLength()

Returns this story file's length.

Returns:

the file length

getChecksum

int getChecksum()

Returns the checksum for the story file.

Returns:

the checksum

getInterpreter

int getInterpreter()

Returns the interpreter number.

Returns:

the interpreter number

getInterpreterVersion

int getInterpreterVersion()

Returns the interpreter version.

Returns:

the interpreter version

getRevision

int getRevision()

Returns the revision number.

Returns:

the revision number