Skip to content

CommandType ​

The block command type enumeration.

Kind: Enum

Namespace: ConnectorLib

Inheritance: IComparable → IConvertible → IFormattable → ISpanFormattable

Public Attributes

CommandType

ReadU8

Reads an unsigned 8-bit value.

CommandType

ReadU16

Reads an unsigned 16-bit value.

CommandType

ReadU32

Reads an unsigned 32-bit value.

CommandType

ReadU64

Reads an unsigned 64-bit value.

CommandType

ReadS8

Reads a signed 8-bit value.

CommandType

ReadS16

Reads a signed 16-bit value.

CommandType

ReadS32

Reads a signed 32-bit value.

CommandType

ReadS64

Reads a signed 64-bit value.

CommandType

ReadBoolean

Reads a C-style boolean value.

CommandType

ReadString

Reads an ASCII string value.

CommandType

ReadState

Reads a save state.

CommandType

ReadBlock

Reads a block of memory.

CommandType

WriteU8

Writes an unsigned 8-bit value.

CommandType

WriteU16

Writes an unsigned 16-bit value.

CommandType

WriteU32

Writes an unsigned 32-bit value.

CommandType

WriteU64

Writes an unsigned 64-bit value.

CommandType

WriteS8

Writes a signed 8-bit value.

CommandType

WriteS16

Writes a signed 16-bit value.

CommandType

WriteS32

Writes a signed 32-bit value.

CommandType

WriteS64

Writes a signed 64-bit value.

CommandType

WriteBoolean

Writes a C-style boolean value.

CommandType

WriteString

Writes an ASCII string value.

CommandType

WriteState

Writes a save state.

CommandType

WriteBlock

Writes a block of memory.

CommandType

SetBits

Sets individual bits of a single byte.

CommandType

UnsetBits

Unsets individual bits of a single byte.

CommandType

CompareSwap

Compares and swaps a byte.

CommandType

FreezeU

Freezes the memory address.

CommandType

UnfreezeAll

Removes all freezes. (BizHawk TCP plugin only.)

CommandType

Unfreeze

Unfreezes the memory address.

CommandType

OpenROM

Loads a ROM file.

CommandType

CloseROM

Unloads a ROM file.

CommandType

GetROMPath

Gets the path of the current ROM file.

CommandType

GetEmulationCore

Gets the emulation core.

CommandType

StateLoad

Loads a savestate.

CommandType

StateSave

Saves a savestate.

CommandType

StateDelete

Deletes a savestate.

CommandType

StateCycle

Saves then immediately loads a savestate.

CommandType

StatePush

Pushes the current state onto the emulator-side state stack. (BizHawk TCP plugin only.)

CommandType

StatePop

Pops and loads the top of the emulator-side state stack. (BizHawk TCP plugin only.)

CommandType

ForceShuffle

Forces the BizHawk Shuffler to swap games, via the Crowd Control shuffler plugin. (BizHawk TCP plugin only.)

CommandType

AddEmulatorSpeed

Increases the current emulation speed.

CommandType

SubEmulatorSpeed

Decreases the current emulation speed.

CommandType

GetEmulatorSpeed

Gets the current emulation speed.

CommandType

SetEmulatorSpeed

Sets the current emulation speed.

CommandType

GetMD5

Gets the MD5 hash of the current ROM file.

CommandType

NextFrameExec

Sets an action to execute once at the start of the next frame.

CommandType

BatchExec

CommandType

AddFrameActions

Sets an action to execute at the start of every frame.

CommandType

RemoveFrameActions

Removes an existing frame callback.

CommandType

AlwaysCallback

Sets an action to execute when a specific memory address changes.

CommandType

EqualsCallback

Sets an action to execute when a specific memory address changes to a specific value.

CommandType

NotEqualsCallback

Sets an action to execute when a specific memory address changes to anything except a specific value.

CommandType

RemoveCallback

Removes an existing memory callback.

CommandType

UserStateLoad

Indicates that the user has loaded a savestate.

CommandType

UserStateSave

Indicates that the user has saved a savestate.

CommandType

UserStateDelete

Indicates that the user has deleted a savestate.

CommandType

SetUserData

Stores a value in the emulator's userdata bag, shared with Lua scripts. (BizHawk TCP plugin only.)

CommandType

GetUserData

Reads a value from the emulator's userdata bag, shared with Lua scripts. (BizHawk TCP plugin only.)

CommandType

SendOverlayMessage

Sends a message to the game overlay.

CommandType

SendTimedMessage

Sends a timed message to the game overlay.

CommandType

PauseTimedMessage

Pauses a timed message on the game overlay.

CommandType

ResumeTimedMessage

Resumes a timed message on the game overlay.

CommandType

ChangeLeftPadding

Changes the left padding of a message on the game overlay.

CommandType

ChangeLeftPaddingAll

Changes the left padding of all messages on the game overlay.

CommandType

RestartBroadcast

Restarts a broadcast message on the game overlay.

CommandType

EmuPause

Pauses emulation.

CommandType

EmuUnpause

Unpauses emulation.

CommandType

EmuReset

Reboots the emulated console.

CommandType

StartComplex

Begins a complex effect.

CommandType

StopComplex

Ends a complex effect.

CommandType

ComplexDone

Emulator-to-client push: a one-shot complex effect finished on its own.

CommandType

EffectsCleared

Emulator-to-client push: the user manually cleared all effects in the emulator UI.

CommandType

KeepAlive

A keep-alive message.

Enums

CommandType

[ReadU8 = 0, ReadU16 = 1, ReadU32 = 2, ReadU64 = 3, ReadS8 = 4, ReadS16 = 5, ReadS32 = 6, ReadS64 = 7, ReadBoolean = 12, ReadString = 13, ReadState = 14, ReadBlock = 15, WriteU8 = 16, WriteU16 = 17, WriteU32 = 18, WriteU64 = 19, WriteS8 = 20, WriteS16 = 21, WriteS32 = 22, WriteS64 = 23, WriteBoolean = 28, WriteString = 29, WriteState = 30, WriteBlock = 31, SetBits = 32, UnsetBits = 33, CompareSwap = 34, FreezeU = 48, UnfreezeAll = 62, Unfreeze = 63, OpenROM = 224, CloseROM = 225, GetROMPath = 226, GetEmulationCore = 227, StateLoad = 228, StateSave = 229, StateDelete = 230, StateCycle = 231, StatePush = 232, StatePop = 233, ForceShuffle = 234, AddEmulatorSpeed = 235, SubEmulatorSpeed = 236, GetEmulatorSpeed = 237, SetEmulatorSpeed = 238, GetMD5 = 239, NextFrameExec = 192, BatchExec = 193, AddFrameActions = 194, RemoveFrameActions = 195, AlwaysCallback = 200, EqualsCallback = 201, NotEqualsCallback = 202, RemoveCallback = 207, UserStateLoad = 212, UserStateSave = 213, UserStateDelete = 214, SetUserData = 215, GetUserData = 216, SendOverlayMessage = 176, SendTimedMessage = 177, PauseTimedMessage = 178, ResumeTimedMessage = 179, ChangeLeftPadding = 180, ChangeLeftPaddingAll = 181, RestartBroadcast = 182, EmuPause = 240, EmuUnpause = 241, EmuReset = 242, StartComplex = 247, StopComplex = 248, ComplexDone = 249, EffectsCleared = 250, KeepAlive = 255]

The block command type enumeration.