PKHeX/PKHeX.Core/Ribbons/IRibbonIndex.cs
Kurt fc754b346b
File scoped namespaces (#3529)
[Language Reference](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/proposals/csharp-10.0/file-scoped-namespaces)

Updates all the files, one less level of indentation.

Some small changes were made to API surfaces, renaming `PKM pkm` -> `PKM pk`, and `LegalityAnalysis.pkm` -> `LegalityAnalysis.Entity`
2022-06-18 11:04:24 -07:00

22 lines
827 B
C#

namespace PKHeX.Core;
/// <summary>
/// Provides access for reading and writing ribbon states by ribbon index within the <see cref="PKM"/> structure.
/// </summary>
public interface IRibbonIndex
{
/// <summary>Gets the state of the ribbon at the requested ribbon index.</summary>
/// <param name="index"><see cref="RibbonIndex"/></param>
bool GetRibbon(int index);
/// <summary>Sets the ribbon index to the provided state.</summary>
/// <param name="index"><see cref="RibbonIndex"/></param>
/// <param name="value">value to set</param>
void SetRibbon(int index, bool value = true);
/// <summary>
/// Gets the value of the byte that has the ribbon <see cref="index"/>.
/// </summary>
/// <param name="index"><see cref="RibbonIndex"/></param>
int GetRibbonByte(int index);
}