SharedScans.Interfaces
1.2.0
dotnet add package SharedScans.Interfaces --version 1.2.0
NuGet\Install-Package SharedScans.Interfaces -Version 1.2.0
<PackageReference Include="SharedScans.Interfaces" Version="1.2.0" />
paket add SharedScans.Interfaces --version 1.2.0
#r "nuget: SharedScans.Interfaces, 1.2.0"
// Install SharedScans.Interfaces as a Cake Addin #addin nuget:?package=SharedScans.Interfaces&version=1.2.0 // Install SharedScans.Interfaces as a Cake Tool #tool nuget:?package=SharedScans.Interfaces&version=1.2.0
SharedScans
A Reloaded II mod for easily sharing sigscans and hooks between mods.
Usage
- In Visual Studio, install the
SharedScans.Interfaces
nuget package. - Add
SharedScans.Reloaded
to your mod's Mod Dependencies inModConfig.json
. - Get the
ISharedScans
API with:modLoader.GetController<ISharedScans>().TryGetTarget(out var scans)
API
Adding Scans
Adding scans requires two things: an ID and a pattern.
AddScan<TFunction>(string? pattern)
The preferred method for adding a scan, where TFunction
is the function delegate type of the pattern. The ID of the scan will be TFunction
, which simplifies hooking it later.
AddScan(string id, string? pattern)
Alternatively, you can manually set the ID of the scan.
Function Hooks and Wrappers
Listen for and then create a hook or wrapper with the given scan.
HookContainer<TFunction> CreateHook<TFunction>(TFunction hookFunction, string owner)
Creates a function hook, using TFunction
as the scan ID to listen for.
WrapperContainer<TFunction> CreateWrapper<TFunction>(string owner)
Creates a function wrapper, using TFunction
as the scan ID to listen for.
Listeners
Listens for the given scan and gets the pattern result.
CreateListener(string id, Action<nint> success)
CreateListener<TFunction>(Action<nint> success)
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net7.0
- Reloaded.Hooks.Definitions (>= 1.15.0)
-
net8.0
- Reloaded.Hooks.Definitions (>= 1.15.0)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on SharedScans.Interfaces:
Package | Downloads |
---|---|
p3rpc.commonmodutils
Supporting logic for Reloaded-II mods, primarily targeting Persona 3 Reload |
|
riri.commonmodutils
Utiltiy code for Reloaded-II mods |
|
P3R.CalendarAPI
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.