A game framework written with osu! in mind.
keii.dev
1// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
2// See the LICENCE file in the repository root for full licence text.
3
4#nullable enable
5
6namespace osu.Framework.Localisation
7{
8 /// <summary>
9 /// A set of parameters that control the way strings are localised.
10 /// </summary>
11 public class LocalisationParameters
12 {
13 /// <summary>
14 /// The <see cref="ILocalisationStore"/> to be used for string lookups and culture-specific formatting.
15 /// </summary>
16 public readonly ILocalisationStore? Store;
17
18 /// <summary>
19 /// Whether to prefer the "original" script of <see cref="RomanisableString"/>s.
20 /// </summary>
21 public readonly bool PreferOriginalScript;
22
23 /// <summary>
24 /// Creates a new instance of <see cref="LocalisationParameters"/>.
25 /// </summary>
26 /// <param name="store">The <see cref="ILocalisationStore"/> to be used for string lookups and culture-specific formatting.</param>
27 /// <param name="preferOriginalScript">Whether to prefer the "original" script of <see cref="RomanisableString"/>s.</param>
28 public LocalisationParameters(ILocalisationStore? store, bool preferOriginalScript)
29 {
30 Store = store;
31 PreferOriginalScript = preferOriginalScript;
32 }
33 }
34}