ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2026-01-01 05:13:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Remove InitialiationTask from interface

Browse source
This commit is contained in:
Soreepeong 2024-02-21 16:34:53 +09:00
parent da969dec5c
commit a3217bb86d
2 changed files with 11 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Dalamud/Plugin/Services/IGameConfig.cs
View file

@ -10,7 +10,10 @@ namespace Dalamud.Plugin.Services;
/// This class represents the game's configuration.
/// </summary>
/// <remarks>
/// Avoid accessing configuration from your plugin constructor, especially if your plugin sets
/// Accessing <see cref="GameConfigSection"/>-typed properties such as <see cref="System"/>, directly or indirectly
/// via <see cref="TryGet(Game.Config.SystemConfigOption,out bool)"/>,
/// <see cref="Set(Game.Config.SystemConfigOption,bool)"/>, or alike will block, if the game is not done loading.<br />
/// Therefore, avoid accessing configuration from your plugin constructor, especially if your plugin sets
/// <see cref="PluginManifest.LoadRequiredState"/> to <c>2</c> and <see cref="PluginManifest.LoadSync"/> to <c>true</c>.
/// If property access from the plugin constructor is desired, do the value retrieval asynchronously via
/// <see cref="IFramework.RunOnFrameworkThread{T}(Func{T})"/>; do not wait for the result right away.
@ -37,16 +40,6 @@ public interface IGameConfig
/// </summary>
public event EventHandler<ConfigChangeEvent> UiControlChanged;
/// <summary>
/// Gets a task representing the initialization state of this instance of <see cref="IGameConfig"/>.
/// </summary>
/// <remarks>
/// Accessing <see cref="GameConfigSection"/>-typed properties such as <see cref="System"/>, directly or indirectly
/// via <see cref="TryGet(Game.Config.SystemConfigOption,out bool)"/>,
/// <see cref="Set(Game.Config.SystemConfigOption,bool)"/>, or alike will block, if this task is incomplete.
/// </remarks>
public Task InitializationTask { get; }
/// <summary>
/// Gets the collection of config options that persist between characters.
/// </summary>