mirror of
https://github.com/WWhiteDreamProject/wwdpublic.git
synced 2026-04-17 21:48:58 +03:00
82cbea2aef
# Description This significantly improves the quality of the language system by fixing the mistakes I've made almost a year ago while developing it. Mainly, this throws away the old half-broken way of networking in favor of the component state system provided by RT. Language speaker comp is now shared with SendOnlyToOwner = true, and its state is handled manually. In addition to that, this brings the following changes: - UniversalLanguageSpeaker and LanguageKnowledge are now server-side - DetermineLanguagesEvent and LanguagesUpdateEvent are now shared (so that future systems can be built in shared, if needed) - Everything now uses the ProtoId<LanguagePrototype> type instead of raw strings (god, I hated those so much) - The server-side language system now accepts Entity<T?> arguments instead of EntityUid + T - UniversalLanguageSpeaker is now based on DetermineEntityLanguagesEvent and gets an Enabled field, which allows to turn it off. This may have some use in the future. - Some minor cleanup <!-- TODO MEDIA <details><summary><h1>Media</h1></summary> <p>  </p> </details> --> # Changelog No cl --------- Co-authored-by: VMSolidus <evilexecutive@gmail.com>
67 lines
2.8 KiB
C#
67 lines
2.8 KiB
C#
using System.Text;
|
|
using Content.Shared.GameTicking;
|
|
using Robust.Shared.Prototypes;
|
|
|
|
namespace Content.Shared.Language.Systems;
|
|
|
|
public abstract class SharedLanguageSystem : EntitySystem
|
|
{
|
|
/// <summary>
|
|
/// The language used as a fallback in cases where an entity suddenly becomes a language speaker (e.g. the usage of make-sentient)
|
|
/// </summary>
|
|
[ValidatePrototypeId<LanguagePrototype>]
|
|
public static readonly string FallbackLanguagePrototype = "TauCetiBasic";
|
|
|
|
/// <summary>
|
|
/// The language whose speakers are assumed to understand and speak every language. Should never be added directly.
|
|
/// </summary>
|
|
[ValidatePrototypeId<LanguagePrototype>]
|
|
public static readonly string UniversalPrototype = "Universal";
|
|
|
|
/// <summary>
|
|
/// A cached instance of <see cref="UniversalPrototype"/>
|
|
/// </summary>
|
|
public static LanguagePrototype Universal { get; private set; } = default!;
|
|
|
|
[Dependency] protected readonly IPrototypeManager _prototype = default!;
|
|
[Dependency] protected readonly SharedGameTicker _ticker = default!;
|
|
|
|
public override void Initialize()
|
|
{
|
|
Universal = _prototype.Index<LanguagePrototype>("Universal");
|
|
}
|
|
|
|
public LanguagePrototype? GetLanguagePrototype(ProtoId<LanguagePrototype> id)
|
|
{
|
|
_prototype.TryIndex(id, out var proto);
|
|
return proto;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Obfuscate a message using the given language.
|
|
/// </summary>
|
|
public string ObfuscateSpeech(string message, LanguagePrototype language)
|
|
{
|
|
var builder = new StringBuilder();
|
|
language.Obfuscation.Obfuscate(builder, message, this);
|
|
|
|
return builder.ToString();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Generates a stable pseudo-random number in the range (min, max) (inclusively) for the given seed.
|
|
/// One seed always corresponds to one number, however the resulting number also depends on the current round number.
|
|
/// This method is meant to be used in <see cref="ObfuscationMethod"/> to provide stable obfuscation.
|
|
/// </summary>
|
|
internal int PseudoRandomNumber(int seed, int min, int max)
|
|
{
|
|
// Using RobustRandom or System.Random here is a bad idea because this method can get called hundreds of times per message.
|
|
// Each call would require us to allocate a new instance of random, which would lead to lots of unnecessary calculations.
|
|
// Instead, we use a simple but effective algorithm derived from the C language.
|
|
// It does not produce a truly random number, but for the purpose of obfuscating messages in an RP-based game it's more than alright.
|
|
seed = seed ^ (_ticker.RoundId * 127);
|
|
var random = seed * 1103515245 + 12345;
|
|
return min + Math.Abs(random) % (max - min + 1);
|
|
}
|
|
}
|