IStatusEffectService
public interface IStatusEffectService : IPluginService
Allows plugins to register custom status effect actions.
Remarks
Naming conflicts are not deterministic. Avoid using common names for your status effect actions. When possible, use unique prefixes to reduce the risk of colliding with action names from other plugins.
Example
You can create new status effect actions by implementing the interface IStatusEffectAction:
public class FooAction : IStatusEffectAction
{
private readonly string _message;
public FooAction(StatusEffect statusEffect, XElement element)
{
_message = element.GetAttributeString("message", "");
}
public void Apply(StatusEffectParams effectParams)
{
if (!_message.IsNullOrEmpty())
{
DebugConsole.NewMessage(_message);
}
}
}
And to register the type, you can use the built-in factory implementation StatusEffectActionFactory:
StatusEffectService.RegisterAction(new StatusEffectActionFactory("Foo", (StatusEffect statusEffect, XElement element) => new FooAction(statusEffect, element)));
Now you can use your new custom action in status effects:
<StatusEffect ...>
<Foo message="Test" />
</StatusEffect>
Members
| Member | Description |
|---|---|
RegisterAction() |
Registers a new status effect action factory that is used to create a status effect action. |
Methods
RegisterAction
void RegisterAction(IStatusEffectActionFactory actionFactory)
Registers a new status effect action factory that is used to create a status effect action.
Related types
StatusEffectParams
public readonly record struct StatusEffectParams(
float DeltaTime,
Entity Entity,
IReadOnlyList<ISerializableEntity> Targets,
Vector2? WorldPosition)
IStatusEffectAction
public interface IStatusEffectAction
Apply
void Apply(StatusEffectParams effectParams)
Called when a status effect with this action activates.
IStatusEffectActionFactory
public interface IStatusEffectActionFactory
SupportsElement
bool SupportsElement(XElement element)
Create
IStatusEffectAction Create(StatusEffect statusEffect, XElement element)
StatusEffectActionFactory
public class StatusEffectActionFactory : IStatusEffectActionFactory
ElementName
string ElementName { get; private set; }
StatusEffectActionFactory
StatusEffectActionFactory(string elementName, Func<StatusEffect, XElement, IStatusEffectAction> createFunc)
SupportsElement
bool SupportsElement(XElement element)
Create
IStatusEffectAction Create(StatusEffect statusEffect, XElement element)