cthangover
aca89c631f
Actions carry the scenario line they were parsed from (SourceLine); ScenarioParser.SplitLine exposes the parser's line split. ScenarioEvent remembers its source mod/file and can start at a label. DialogRuntime asks an optional IDialogDebugger before every action and can be held; DialogBox resumes a held dialog and aborts one without completing it.
63 lines
2.6 KiB
C#
63 lines
2.6 KiB
C#
using System.Collections.Generic;
|
|
using Cthangover.Core.UI;
|
|
using Cthangover.Mods.Interface.Base.Lists;
|
|
using Cthangover.Core.UI.Dialog;
|
|
using Cthangover.Core.UI.Event;
|
|
using Cthangover.Core.UI.Executable;
|
|
using Cthangover.Core.Scenarios;
|
|
using Cthangover.Core.Scenes;
|
|
using Cthangover.Core.Interactive;
|
|
|
|
namespace Cthangover.Mods.Dialog.Action
|
|
{
|
|
/// <summary>
|
|
/// Full dialog action contract: extends IActionDestruct with construction,
|
|
/// execution (Run), and queryable state (WaitType, timing enums, delayed-destruct
|
|
/// dependencies). The ID property enables cross-action references (GoTo, If).
|
|
/// </summary>
|
|
public interface IActionCommand : IActionDestruct
|
|
{
|
|
|
|
#region Properties
|
|
|
|
/// <summary>Unique action identifier, auto-generated GUID. Can be overridden for named GoTo targets.</summary>
|
|
string ID { get; set; }
|
|
|
|
/// <summary>Whether <see cref="Construct"/> has completed.</summary>
|
|
bool IsConstructed { get; }
|
|
/// <summary>Whether <see cref="Destruct"/> has been called and the action is finished.</summary>
|
|
bool IsDestructed { get; }
|
|
/// <summary>Controls when construction fires relative to the action's lifecycle.</summary>
|
|
ConstructType ConstructType { get; }
|
|
/// <summary>Controls when destruction fires relative to the action's lifecycle.</summary>
|
|
DestructType DestructType { get; }
|
|
/// <summary>How the runtime should handle advancement past this action.</summary>
|
|
WaitType WaitType { get; }
|
|
/// <summary>IDs of actions whose Destruct should be called when this action destructs.</summary>
|
|
ISet<string> DelayedDestruct { get; }
|
|
/// <summary>Duration in seconds when WaitType is WaitTime.</summary>
|
|
float WaitTime { get; }
|
|
/// <summary>Timestamp of the last <see cref="Run"/> call, in seconds since epoch.</summary>
|
|
float StartTime { get; }
|
|
/// <summary>
|
|
/// 1-based line of the scenario text this action was parsed from, 0 for
|
|
/// actions built in code. Set by <see cref="Scenarios.ScenarioParser"/>;
|
|
/// debugging tools map the running action back to the script with it.
|
|
/// </summary>
|
|
int SourceLine { get; set; }
|
|
|
|
#endregion
|
|
|
|
#region Methods
|
|
|
|
/// <summary>Called by the runtime to initialize the action before execution.</summary>
|
|
void Construct();
|
|
/// <summary>Called by the runtime to execute the action. Receives the runtime for context.</summary>
|
|
void Run(DialogRuntime runtime);
|
|
|
|
#endregion
|
|
|
|
}
|
|
|
|
}
|