BizhawkConnector

Implements several IConsoleConnector types with a Bizhawk plugin.

Kind: Class

Namespace: ConnectorLib

Inheritance: ConsoleBase → I16BitConnector → I32BitConnector → I64BitConnector → I8BitConnector → IAddressableConnector → IConsoleConnector → IDisposable → IDomainMappableConnector → IDomainMappableConnector\<BizhawkConnector\> → IFreezableConnector → IGBAConnector → IGBConnector → IGameConnector → IGameGearConnector → IGenesisConnector → IN64Connector → INESConnector → INESProConnector → IPS1Connector → IROMProcessor → ISNESConnector

Public Constructors

BizhawkConnector()

Creates a new LuaConnector object with a specified endpoint.

BizhawkConnector(string url)

Creates a new LuaConnector object with a specified endpoint.

BizhawkConnector(Action messageHandler, string url = "ws://localhost:21838/")

Creates a new LuaConnector object with a specified endpoint.

Public Member Functions

virtual override

Task>

Connect()

virtual override

Task

Disconnect(string message)

virtual override

bool

Write(ulong address, ReadOnlySpan buffer, int offset, int length)

virtual override

bool

Write(ulong address, string domain, ReadOnlySpan buffer, int offset, int length)

virtual override

bool

Read(ulong address, Span buffer, int offset, int length)

virtual override

bool

Read(ulong address, string domain, Span buffer, int offset, int length)

virtual override

bool

SendMessage(string message)

Sends a message to be displayed.

bool

SendMessage(string[] lines)

Sends a message to be displayed.

bool

StartTimedMessage(string[] lines, TimeSpan duration, int out id)

Sends a message to be displayed.

bool

PauseTimedMessage(int id)

Sends a message to be displayed.

bool

ResumeTimedMessage(int id)

Sends a message to be displayed.

bool

ResumeTimedMessage(int id, TimeSpan elapsed)

Sends a message to be displayed.

bool

ChangeMessagePadding(int id, int padding)

bool

ChangeAllPadding(int padding)

virtual override

bool

Freeze(ulong address, string domain, ulong value, byte size, WriteType writeType, ulong cmpAddress, ulong cmpValue, byte cmpSize, CompareType condition)

virtual override

bool

Freeze(ulong address, string domain, ulong value, ulong mask, byte size, WriteType writeType, ulong cmpAddress, ulong cmpValue, byte cmpSize, CompareType condition)

virtual override

bool

Freeze(ulong address, ulong value, byte size, WriteType writeType, ulong cmpAddress, ulong cmpValue, byte cmpSize, CompareType cmpType)

virtual override

bool

Freeze(ulong address, ulong value, ulong mask, byte size, WriteType writeType, ulong cmpAddress, ulong cmpValue, byte cmpSize, CompareType condition)

bool

CompareSwap(ulong chkAddress, byte test, byte newVal, byte out orig)

bool

FreezeU8(ulong address, byte value)

bool

FreezeU16(ulong address, ushort value)

bool

FreezeU32(ulong address, uint value)

bool

FreezeU64(ulong address, ulong value)

virtual override

bool

Unfreeze(ulong address, string domain)

virtual override

bool

Unfreeze(ulong address)

DomainMappedConnector

WithDomain(string domain)

bool

Write8(ulong address, byte value)

bool

Write16(ulong address, ushort value)

bool

Write32(ulong address, uint value)

bool

Write64(ulong address, ulong value)

bool

Read8(ulong address, byte out value)

bool

Read16(ulong address, ushort out value)

bool

Read32(ulong address, uint out value)

bool

Read64(ulong address, ulong out value)

bool

SetBits(ulong address, byte value, byte out oldValue)

virtual override

bool

SetBits(ulong address, string domain, byte value, byte out oldValue)

bool

UnsetBits(ulong address, byte value, byte out oldValue)

virtual override

bool

UnsetBits(ulong address, string domain, byte value, byte out oldValue)

virtual override

void

KeepAlive()

virtual override

string

GetROMPath()

virtual override

bool

OpenROM(string localPath)

virtual override

bool

CloseROM()

virtual override

bool

PatchROM(IROMPatch patch)

virtual override

bool

PatchROM(byte[] data)

virtual override

bool

ResetConsole()

bool

StateCycle(string out key, bool keep = true)

bool

StateSave(string out key)

bool

StateLoad(string key)

bool

StateDelete(string key)

bool

StartComplex(ComplexEffect effect)

bool

StopComplex(ComplexEffect effect)

bool

StartComplex(string effectName)

bool

StopComplex(string effectName)

Public Attributes

string

DEFAULT_URL

Properties

Endianness

Endianness

[get, ]

PointerFormat

PointerFormat

[get, ]

IFeatureAware

Features

[get, ]

PointerFormat

RelativePointerFormat

[get, ]

static

int

CommandResponseTimeoutMS

[get, set]

Allows globally configuring the default timeout before messages from a connected Lua connector script will be considered lost/never arriving. Defaults to 1000ms

bool

Connected

[get, ]

IMemoryMapper

Mapper

[, set]