Class JumpPatch

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

Replaces whole instructions with a jump, so the code at Address continues at Target.

public sealed class JumpPatch : CodePatch

Inheritance

object

CodePatch

JumpPatch

Inherited Members

CodePatch.Address

CodePatch.Expected

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

The jump occupies the first five expected bytes, and the rest of them become nops. The expected bytes therefore end on an instruction, and no branch elsewhere in the function lands inside them. Apply(params ReadOnlySpan<CodePatch>) detects a direct branch in the function part the exception directory lists, not a branch through a jump table or a register. The target begins an instruction where its module's exception directory lists the function containing it, and lies inside no recorded patch or hook past its first byte.

The target lies within a 32-bit displacement of the address, as the game's own code and memory from AllocateCode(nint, int) do. The entry point of a managed method usually does not, so a plugin redirecting game code to managed code uses IFunctionHooks. Code in allocated memory is complete before the jump reaching it is applied.

Constructors

JumpPatch(nint, BytePattern, nint)

Creates a patch replacing the expected bytes at address with a jump to target.

public JumpPatch(nint address, BytePattern expected, nint target)

Parameters

address nint

The address of the first expected byte.

expected BytePattern

The bytes the code at address must match: the whole instructions replaced, at least five bytes.

target nint

The address the jump reaches.

Exceptions

ArgumentOutOfRangeException

address or target is 0, expected is shorter than five bytes, or target lies farther from address than a 32-bit displacement reaches.

ArgumentNullException

expected is null.

Properties

Target

The address the jump reaches.

public nint Target { get; }

Property Value

nint