XivCommon/XivCommon/XivCommonBase.cs

32 lines
857 B
C#
Raw Normal View History

2021-04-06 08:41:38 +00:00
using System;
using Dalamud.Plugin;
2021-04-06 08:41:38 +00:00
2023-10-03 06:25:45 +00:00
namespace XivCommon;
/// <summary>
/// A base class for accessing XivCommon functionality.
/// </summary>
public class XivCommonBase : IDisposable {
/// <summary>
2023-10-03 06:25:45 +00:00
/// Game functions and events
/// </summary>
2023-10-03 06:25:45 +00:00
public GameFunctions Functions { get; }
2021-04-06 08:41:38 +00:00
2023-10-03 06:25:45 +00:00
/// <summary>
/// <para>
/// Construct a new XivCommon base.
/// </para>
/// <para>
/// This will automatically enable hooks based on the hooks parameter.
/// </para>
/// </summary>
/// <param name="hooks">Flags indicating which hooks to enable</param>
public XivCommonBase(DalamudPluginInterface @interface, Hooks hooks = HooksExt.DefaultHooks) {
this.Functions = new GameFunctions(@interface, hooks);
2023-10-03 06:25:45 +00:00
}
2021-04-06 08:41:38 +00:00
2023-10-03 06:25:45 +00:00
/// <inheritdoc />
public void Dispose() {
this.Functions.Dispose();
2021-04-06 08:41:38 +00:00
}
2023-10-03 06:25:45 +00:00
}