Toast namespaces

This commit is contained in:
Raymond 2021-08-09 18:29:38 -04:00
parent bab8eb4182
commit 72e10771a5
7 changed files with 10 additions and 8 deletions

View file

@ -0,0 +1,32 @@
namespace Dalamud.Game.Gui.Toast
{
/// <summary>
/// This class represents options that can be used with the <see cref="ToastGui"/> class for the quest toast variant.
/// </summary>
public sealed class QuestToastOptions
{
/// <summary>
/// Gets or sets the position of the toast on the screen.
/// </summary>
public QuestToastPosition Position { get; set; } = QuestToastPosition.Centre;
/// <summary>
/// Gets or sets the ID of the icon that will appear in the toast.
///
/// This may be 0 for no icon.
/// </summary>
public uint IconId { get; set; } = 0;
/// <summary>
/// Gets or sets a value indicating whether the toast will show a checkmark after appearing.
/// </summary>
public bool DisplayCheckmark { get; set; } = false;
/// <summary>
/// Gets or sets a value indicating whether the toast will play a completion sound.
///
/// This only works if <see cref="IconId"/> is non-zero or <see cref="DisplayCheckmark"/> is true.
/// </summary>
public bool PlaySound { get; set; } = false;
}
}

View file

@ -0,0 +1,23 @@
namespace Dalamud.Game.Gui.Toast
{
/// <summary>
/// The alignment of native quest toast windows.
/// </summary>
public enum QuestToastPosition
{
/// <summary>
/// The toast will be aligned screen centre.
/// </summary>
Centre = 0,
/// <summary>
/// The toast will be aligned screen right.
/// </summary>
Right = 1,
/// <summary>
/// The toast will be aligned screen left.
/// </summary>
Left = 2,
}
}

View file

@ -0,0 +1,18 @@
namespace Dalamud.Game.Gui.Toast
{
/// <summary>
/// This class represents options that can be used with the <see cref="ToastGui"/> class.
/// </summary>
public sealed class ToastOptions
{
/// <summary>
/// Gets or sets the position of the toast on the screen.
/// </summary>
public ToastPosition Position { get; set; } = ToastPosition.Bottom;
/// <summary>
/// Gets or sets the speed of the toast.
/// </summary>
public ToastSpeed Speed { get; set; } = ToastSpeed.Slow;
}
}

View file

@ -0,0 +1,18 @@
namespace Dalamud.Game.Gui.Toast
{
/// <summary>
/// The positioning of native toast windows.
/// </summary>
public enum ToastPosition : byte
{
/// <summary>
/// The toast will be towards the bottom.
/// </summary>
Bottom = 0,
/// <summary>
/// The toast will be towards the top.
/// </summary>
Top = 1,
}
}

View file

@ -0,0 +1,18 @@
namespace Dalamud.Game.Gui.Toast
{
/// <summary>
/// The speed at which native toast windows will persist.
/// </summary>
public enum ToastSpeed : byte
{
/// <summary>
/// The toast will take longer to disappear (around four seconds).
/// </summary>
Slow = 0,
/// <summary>
/// The toast will disappear more quickly (around two seconds).
/// </summary>
Fast = 1,
}
}