mirror of
https://github.com/goatcorp/Dalamud.git
synced 2026-01-03 06:13:40 +01:00
Toast namespaces
This commit is contained in:
parent
bab8eb4182
commit
72e10771a5
7 changed files with 10 additions and 8 deletions
32
Dalamud/Game/Gui/Toast/QuestToastOptions.cs
Normal file
32
Dalamud/Game/Gui/Toast/QuestToastOptions.cs
Normal 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;
|
||||
}
|
||||
}
|
||||
23
Dalamud/Game/Gui/Toast/QuestToastPosition.cs
Normal file
23
Dalamud/Game/Gui/Toast/QuestToastPosition.cs
Normal 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,
|
||||
}
|
||||
}
|
||||
18
Dalamud/Game/Gui/Toast/ToastOptions.cs
Normal file
18
Dalamud/Game/Gui/Toast/ToastOptions.cs
Normal 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;
|
||||
}
|
||||
}
|
||||
18
Dalamud/Game/Gui/Toast/ToastPosition.cs
Normal file
18
Dalamud/Game/Gui/Toast/ToastPosition.cs
Normal 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,
|
||||
}
|
||||
}
|
||||
18
Dalamud/Game/Gui/Toast/ToastSpeed.cs
Normal file
18
Dalamud/Game/Gui/Toast/ToastSpeed.cs
Normal 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,
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue