TnmsExtendableTargeting.Shared 0.0.1

TnmsExtendableTargeting

What is this?

This module provides extendable targeting functionality.

It offers the following types of targeting:

• @prefix - Target without parameters
• @prefix=value - Target with parameters

Built-in Targets

The following targeting options are provided out of the box:

Usage

Dependencies

Install TnmsExtendableTargeting.Shared from NuGet:

dotnet add package TnmsExtendableTargeting.Shared

Example

You can obtain IExtendableTargeting as follows:

private IExtendableTargeting _extendableTargeting = null!;

public void OnAllModulesLoaded()
{
    var extendableTargeting = _sharedSystem.GetSharpModuleManager()
        .GetRequiredSharpModuleInterface<IExtendableTargeting>(IExtendableTargeting.ModSharpModuleIdentity).Instance;
    _extendableTargeting = extendableTargeting ?? throw new InvalidOperationException("TnmsExtendableTargeting is not found! Make sure TnmsExtendableTargeting is installed!");
}

Then, resolve targets as follows:

if(_extendableTargeting.ResolveTarget(targetString, player, out var foundTargets))
{
    // Do something with foundTargets
}

Creating Custom Targets

As the name suggests, ExtendableTargeting allows you to add and extend custom targets.

Once added, custom targets can be used anywhere IExtendableTargeting.ResolveTarget is used. In other words, they are available in all modules that use this functionality.

Custom Targets Without Parameters

Register a custom target without parameters using IExtendableTargeting.RegisterCustomTarget.

The prefix must start with @. If it does not, @ will be automatically prepended.

Examples:

• @mytarget → @mytarget
• mytarget → @mytarget
• $mytarget → @$mytarget

IExtendableTargeting.RegisterCustomTarget("@me", Me);

public static bool Me(IGameClient targetClient, IGameClient? caller)
{
    return caller?.Slot == targetClient.Slot;
}

Custom Targets With Parameters

Register a custom target with parameters using IExtendableTargeting.RegisterCustomTargetWithParam.

The prefix must start with @. If it does not, @ will be automatically prepended.

Examples:

• @mytarget → @mytarget
• mytarget → @mytarget
• $mytarget → @$mytarget

IExtendableTargeting.RegisterCustomTargetWithParam("@slot", Slot);
public static bool Slot(string param, IGameClient targetClient, IGameClient? caller)
{
    if(int.TryParse(param, out var slot))
    {
        return targetClient.Slot == slot;
    }
    return false;
}

Custom targets with parameters can be used in the form @prefix=value.