Semi-automatically generated modding documentation for Barotrauma

IEventActionRegistrar

public interface IEventActionRegistrar : IPluginService

Provides methods for registering custom event actions to be loaded in ScriptedEvent.

Remarks

The methods are instance methods. The examples assume an instance has been retrieved and stored, e.g.:

public static readonly IEventActionRegistrar EventActionRegistrar = PluginServiceProvider.GetService<IEventActionRegistrar>();

Members

Member Description
RegisterEventAction<T>() Registers a custom event action to be recognized by ScriptedEvent.
RegisterEventActions() Registers multiple custom event actions to be recognized by ScriptedEvent.
RegisterAllEventActions() Registers all types in the calling plugin that inherit EventAction.

Methods

RegisterEventAction

void RegisterEventAction<T>() where T : EventAction

Registers a custom event action to be recognized by ScriptedEvent.

Type parameter Description
T Implementation of EventAction to register.

Example

MyEventAction.cs:

public class MyEventAction(ScriptedEvent parentEvent, ContentXElement element) : EventAction(parentEvent, element)
{
    private bool isFinished;

    public override bool IsFinished(ref string goToLabel)
        => isFinished;

    public override void Reset()
        => isFinished = false;

    public override void Update(float deltaTime)
    {
        // Do something
        isFinished = true;
    }
}

Plugin init:

EventActionRegistrar.RegisterEventAction<MyEventAction>();

RegisterEventActions

void RegisterEventActions(params Type[] types)

Registers multiple custom event actions to be recognized by ScriptedEvent.

Parameter Type Description
types Type[] Types of EventAction to register.
Exception Condition
ArgumentException if a type does not inherit EventAction.

Example

MyEventAction.cs:

public class MyEventAction(ScriptedEvent parentEvent, ContentXElement element) : EventAction(parentEvent, element)
{
    private bool isFinished;

    public override bool IsFinished(ref string goToLabel)
        => isFinished;

    public override void Reset()
        => isFinished = false;

    public override void Update(float deltaTime)
    {
        // Do something
        isFinished = true;
    }
}

Plugin init:

EventActionRegistrar.RegisterEventActions(typeof(MyEventAction), typeof(MyOtherEventAction));

RegisterAllEventActions

void RegisterAllEventActions()

Registers all types in the calling plugin that inherit EventAction.

Remarks

The method will find all types in the calling assembly that inherit EventAction and register them using RegisterEventActions.

Example

Plugin init:

EventActionRegistrar.RegisterAllEventActions();