A game framework written with osu! in mind.
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
4using System;
5
6#nullable enable
7
8namespace osu.Framework.Localisation
9{
10 /// <summary>
11 /// An interface for <see cref="LocalisableString"/>'s data.
12 /// </summary>
13 public interface ILocalisableStringData : IEquatable<ILocalisableStringData>
14 {
15 /// <summary>
16 /// Gets a localised <see cref="string"/> using the given localisation store and other required data.
17 /// </summary>
18 /// <param name="parameters">Any parameters that control the localisation method.</param>
19 string GetLocalised(LocalisationParameters parameters);
20 }
21}