readZString static method

String readZString(
  1. int fromAddress, [
  2. bool abbreviationLookup = false
])

Reads a string of Z characters and returns the decoded version. Also pushes the address after the string to the call stack.

The value MUST be popped off the stack by the caller:

Example

ZSCII.readZString(startingAtSomeAddress);
Z.callStack.pop();

Call ZSCII.readZStringAndPop(...) if you want the pop to happen automatically after the read.

Implementation

static String readZString(int fromAddress, [bool abbreviationLookup = false]) {
  final str = _stringReaderMap[Z.engine.version]!(fromAddress, abbreviationLookup);
  //print("Read string (abbreviation lookup? $abbreviationLookup): $str");
  return str;
}