This repository has been archived by the owner on Jan 19, 2025. It is now read-only.
HintModule #2728
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| // ----------------------------------------------------------------------- | ||
| // <copyright file="HintPatch.cs" company="Exiled Team"> | ||
| // Copyright (c) Exiled Team. All rights reserved. | ||
| // Licensed under the CC BY-SA 3.0 license. | ||
| // </copyright> | ||
| // ----------------------------------------------------------------------- | ||
|
|
||
| using Hints; | ||
|
|
||
|
|
||
| namespace Exiled.API.Features.CustomHints | ||
| { | ||
| using System; | ||
| using System.Collections.Generic; | ||
|
|
||
| using HarmonyLib; | ||
| using Hints; | ||
| using Mirror; | ||
|
|
||
| /// <summary> | ||
| /// The patch for hints. | ||
| /// </summary> | ||
| [HarmonyPatch(typeof(HintDisplay))] | ||
| [HarmonyPatch("Show")] | ||
| public static class HintPatch | ||
|
There was a problem hiding this comment. both attributes can be in the same one |
||
| { | ||
| #pragma warning disable SA1313 | ||
| private static bool Prefix(HintDisplay __instance, ref global::Hints.Hint hint) | ||
| #pragma warning restore SA1313 | ||
| { | ||
| if (hint.GetType() != typeof(TextHint)) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| TextHint textHint = (TextHint)hint; | ||
| HintSys.Display(textHint.Text, textHint.DurationScalar, [Player.Get(__instance.netIdentity)]); | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| // ----------------------------------------------------------------------- | ||
| // <copyright file="HintSys.cs" company="Exiled Team"> | ||
| // Copyright (c) Exiled Team. All rights reserved. | ||
| // Licensed under the CC BY-SA 3.0 license. | ||
| // </copyright> | ||
| // ----------------------------------------------------------------------- | ||
|
|
||
| using Hints; | ||
| using RueI.Displays; | ||
| using RueI.Elements; | ||
| using RueI.Parsing; | ||
| using RueI.Parsing.Records; | ||
|
|
||
|
There was a problem hiding this comment. all of this should be with the other ones, also why using 2 Hints Namespaces |
||
| namespace Exiled.API.Features.CustomHints | ||
| { | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Runtime.CompilerServices; | ||
|
|
||
| using Hints; | ||
| using MEC; | ||
| using Mirror; | ||
|
|
||
| /// <summary> | ||
| /// A powerful hint system that allows multiple concurrent hints. | ||
| /// </summary> | ||
| public static class HintSys | ||
| { | ||
| /// <summary> | ||
| /// A dictionary containing the caller and a tuple containing the hint, a list of players to receive the hint, and the timestamp the hint was sent at. | ||
| /// </summary> | ||
| private static Dictionary<string, Tuple<Hint, List<Player>, long>> hints = new(); | ||
|
|
||
| private static Dictionary<Player, List<string>> playerHints = new(); | ||
|
|
||
| private static CoroutineHandle? hintHandle; | ||
|
|
||
| /// <summary> | ||
| /// Gets the hints. | ||
| /// </summary> | ||
| /// <returns>A dictionary containing all hints, modifying will do nothing.</returns> | ||
| public static Dictionary<string, Tuple<Hint, List<Player>, long>> GetHints() | ||
| { | ||
| return new Dictionary<string, Tuple<Hint, List<Player>, long>>(hints); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Adds a hint to the display queue, if there is already a hint by this caller, replaces it. | ||
| /// </summary> | ||
| /// <param name="content">The content of the hint.</param> | ||
| /// <param name="duration">The duration in seconds.</param> | ||
| /// <param name="players">A list of players to add to the hint.</param> | ||
| /// <param name="caller">Do not populate.</param> | ||
| public static void Display(string content, float duration, List<Player> players, [CallerMemberName] string caller = "") | ||
| { | ||
| Hint hint = new() | ||
| { | ||
| Content = content, | ||
| Duration = duration, | ||
| }; | ||
| hints[caller] = new Tuple<Hint, List<Player>, long>(hint, players, DateTimeOffset.UtcNow.ToUnixTimeSeconds()); | ||
| foreach (Player player in players) | ||
| { | ||
| playerHints.GetOrAdd(player, () => new List<string>()).Add(caller); | ||
| } | ||
|
|
||
| hintHandle ??= Timing.RunCoroutine(HintDisplayLoop()); | ||
| } | ||
|
|
||
| private static void Send(string hintText, Player player) | ||
| { | ||
| HintDisplay hintDisplay = player.ReferenceHub.hints; | ||
| if (hintDisplay.isLocalPlayer) | ||
| throw new InvalidOperationException("Cannot display a hint to the local player (headless server)."); | ||
| if (!NetworkServer.active) | ||
| return; | ||
| NetworkConnection connectionToClient = hintDisplay.netIdentity.connectionToClient; | ||
| if (HintDisplay.SuppressedReceivers.Contains(connectionToClient)) | ||
| return; | ||
| TextHint hint = new TextHint(hintText, [new StringHintParameter(hintText)], null); | ||
| connectionToClient.Send(new HintMessage(hint)); | ||
| } | ||
|
There was a problem hiding this comment. make sure to leave a blank line after the returns and the new InvalidOperationException |
||
|
|
||
| private static IEnumerator<float> HintDisplayLoop() | ||
| { | ||
| for (; ;) | ||
| { | ||
| foreach (KeyValuePair<Player, List<string>> keyValuePair in playerHints) | ||
| { | ||
| List<ParsedData> parserContexts = []; | ||
| foreach (string se in keyValuePair.Value.ToList()) | ||
| { | ||
| Tuple<Hint, List<Player>, long> item = hints[se]; | ||
| if (!item.Item2.Contains(keyValuePair.Key)) | ||
| continue; | ||
| if ((item.Item3 - DateTimeOffset.UtcNow.ToUnixTimeSeconds()) > item.Item1.Duration) | ||
|
There was a problem hiding this comment. same here for the continue up here |
||
| { | ||
| hints.Remove(se); | ||
| keyValuePair.Value.Remove(se); | ||
| continue; | ||
| } | ||
|
|
||
| parserContexts.Add(Parser.DefaultParser.Parse(item.Item1.Content)); | ||
| } | ||
|
|
||
| string hint = ElemCombiner.Combine(parserContexts); | ||
| Send(hint, keyValuePair.Key); | ||
| } | ||
|
|
||
| if (hints.Count == 0) | ||
| { | ||
| hintHandle = null; | ||
| break; | ||
| } | ||
|
|
||
| yield return Timing.WaitForSeconds(0.572f); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <OutputType>Library</OutputType> | ||
| <AssemblyName>Exiled.Hints</AssemblyName> | ||
| <AllowUnsafeBlocks>true</AllowUnsafeBlocks> | ||
| <Configurations>Debug;Release;Installer</Configurations> | ||
| <Platforms>AnyCPU</Platforms> | ||
| <TargetFramework>net48</TargetFramework> | ||
| <LangVersion>latest</LangVersion> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\Exiled.API\Exiled.API.csproj" /> | ||
| <ProjectReference Include="..\Exiled.CustomModules/Exiled.CustomModules.csproj" /> | ||
| <ProjectReference Include="..\RueI\RueI.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Reference Include="Assembly-CSharp" HintPath="$(EXILED_REFERENCES)\Assembly-CSharp-Publicized.dll" Private="false" /> | ||
| <Reference Include="Assembly-CSharp-firstpass" HintPath="$(EXILED_REFERENCES)\Assembly-CSharp-firstpass.dll" Private="false" /> | ||
| <Reference Include="CommandSystem.Core" HintPath="$(EXILED_REFERENCES)\CommandSystem.Core.dll" Private="false" /> | ||
| <Reference Include="Mirror" HintPath="$(EXILED_REFERENCES)\Mirror.dll" Private="false" /> | ||
| <Reference Include="UnityEngine.CoreModule" HintPath="$(EXILED_REFERENCES)\UnityEngine.CoreModule.dll" Private="false" /> | ||
| <Reference Include="NorthwoodLib" HintPath="$(EXILED_REFERENCES)\NorthwoodLib.dll" Private="false" /> | ||
| <Reference Include="PluginAPI" HintPath="$(EXILED_REFERENCES)\PluginAPI.dll" Private="false" /> | ||
| <Reference Include="UnityEngine.PhysicsModule" HintPath="$(EXILED_REFERENCES)\UnityEngine.PhysicsModule.dll" Private="false" /> | ||
| <Reference Include="YamlDotNet" HintPath="$(EXILED_REFERENCES)\YamlDotNet.dll" Private="false" /> | ||
| <Reference Include="System.Collections.Immutable"> | ||
| <HintPath>$(EXILED_REFERENCES)\System.Collections.Immutable.dll</HintPath> | ||
| </Reference> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Compile Update="Properties\Resources.Designer.cs"> | ||
| <DesignTime>True</DesignTime> | ||
| <AutoGen>True</AutoGen> | ||
| <DependentUpon>Resources.resx</DependentUpon> | ||
| </Compile> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <EmbeddedResource Update="Properties\Resources.resx"> | ||
| <Generator>ResXFileCodeGenerator</Generator> | ||
| <LastGenOutput>Resources.Designer.cs</LastGenOutput> | ||
| </EmbeddedResource> | ||
| </ItemGroup> | ||
|
|
||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="System.Collections.Immutable" Version="8.0.0" /> | ||
| </ItemGroup> | ||
|
|
||
| <PropertyGroup Condition=" '$(OS)' == 'Windows_NT' "> | ||
| <PostBuildEvent>if not "$(EXILED_DEV_REFERENCES)"=="" copy /y "$(OutputPath)$(AssemblyName).dll" "$(EXILED_DEV_REFERENCES)\Plugins\"</PostBuildEvent> | ||
| </PropertyGroup> | ||
| <PropertyGroup Condition=" '$(OS)' == 'Unix' "> | ||
| <PostBuildEvent>if [[ ! -z "$EXILED_DEV_REFERENCES" ]]; then cp "$(OutputPath)$(AssemblyName).dll" "$EXILED_DEV_REFERENCES/Plugins/"; fi</PostBuildEvent> | ||
| </PropertyGroup> | ||
|
|
||
| </Project> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| using Exiled.API.Interfaces; | ||
|
|
||
| namespace Exiled.Hints; | ||
|
|
||
| public class HintConfig : IConfig | ||
| { | ||
| public bool IsEnabled { get; set; } | ||
| public bool Debug { get; set; } | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| using Exiled.API.Features; | ||
| using Exiled.CustomModules.API.Features; | ||
| using HarmonyLib; | ||
|
|
||
| namespace Exiled.Hints | ||
| { | ||
| public class CustomHints : CustomModule | ||
| { | ||
| public override string Name { get; set; } = "CustomHints"; | ||
| public override uint Id { get; set; } | ||
| public override bool IsEnabled { get; set; } | ||
| public override ModulePointer Config { get; set; } | ||
| } | ||
|
|
||
| public class CustomHintsPlugin : Plugin<HintConfig> | ||
| { | ||
|
|
||
| private Harmony harmony; | ||
|
|
||
| public override void OnEnabled() | ||
| { | ||
| harmony = new Harmony("exiled.hints"); | ||
| if (CustomHints.OnEnabled.BoundDelegates.ContainsKey(this)) return; | ||
|
|
||
| CustomHints.OnEnabled += OnModuleEnable; | ||
| CustomHints.OnDisabled += OnModuleDisable; | ||
| } | ||
|
|
||
| private void OnModuleEnable(ModuleInfo info) | ||
| { | ||
| harmony.PatchAll(); | ||
| } | ||
|
|
||
| private void OnModuleDisable(ModuleInfo info) | ||
| { | ||
| harmony.UnpatchAll(); | ||
| } | ||
|
There was a problem hiding this comment.
|
||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no.