From c749a8491029a0fef85486975fdf77046e823433 Mon Sep 17 00:00:00 2001 From: AeonLucid Date: Mon, 26 Oct 2020 00:17:47 +0100 Subject: [PATCH] Move events to better directories --- docs/Writing-a-plugin.md | 7 +++++++ .../Events/{Game => Meeting}/MeetingEndedEvent.cs | 2 +- .../Events/{Game => Meeting}/MeetingStartedEvent.cs | 0 .../Events/{Game => Player}/PlayerChatEvent.cs | 2 +- .../Events/{Game => Player}/PlayerDestroyedEvent.cs | 2 +- .../Events/{Game => Player}/PlayerJoinedGameEvent.cs | 2 +- .../Events/{Game => Player}/PlayerLeftGameEvent.cs | 2 +- .../Events/{Game => Player}/PlayerMovementEvent.cs | 2 +- .../Events/{Game => Player}/PlayerSpawnedEvent.cs | 2 +- src/Impostor.Plugins.Debugger/Pages/Index.razor | 1 + src/Impostor.Plugins.Example/Handlers/GameEventListener.cs | 1 + .../Handlers/MeetingEventListener.cs | 1 + .../Handlers/PlayerEventListener.cs | 2 +- .../Impostor.Plugins.Example.csproj | 2 +- src/Impostor.Server/Net/Inner/Objects/InnerMeetingHud.cs | 1 + .../Net/Inner/Objects/InnerPlayerControl.cs | 2 +- src/Impostor.Server/Net/State/Game.Data.cs | 2 +- src/Impostor.Server/Net/State/Game.State.cs | 1 + 18 files changed, 23 insertions(+), 11 deletions(-) rename src/Impostor.Api/Events/{Game => Meeting}/MeetingEndedEvent.cs (90%) rename src/Impostor.Api/Events/{Game => Meeting}/MeetingStartedEvent.cs (100%) rename src/Impostor.Api/Events/{Game => Player}/PlayerChatEvent.cs (92%) rename src/Impostor.Api/Events/{Game => Player}/PlayerDestroyedEvent.cs (91%) rename src/Impostor.Api/Events/{Game => Player}/PlayerJoinedGameEvent.cs (90%) rename src/Impostor.Api/Events/{Game => Player}/PlayerLeftGameEvent.cs (91%) rename src/Impostor.Api/Events/{Game => Player}/PlayerMovementEvent.cs (85%) rename src/Impostor.Api/Events/{Game => Player}/PlayerSpawnedEvent.cs (91%) diff --git a/docs/Writing-a-plugin.md b/docs/Writing-a-plugin.md index 267d983..99e99a3 100644 --- a/docs/Writing-a-plugin.md +++ b/docs/Writing-a-plugin.md @@ -66,6 +66,13 @@ Make sure to get a prerelease if you are writing a plugin for a dev release of t 5. Search for `Impostor.Api`. 6. Click the `Impostor.Api` result and press install on the right side. +### Dotnet CLI + +> Make sure to grab the latest (pre-)release version from NuGet [here](https://www.nuget.org/packages/Impostor.Api). + +1. Open your project folder in command prompt / bash. +2. Run `dotnet add package Impostor.Api -v "1.2.0-ci.58"`. + ## 4. The plugin class Now the `Impostor.Api` is installed, you need to create a class for your plugin. A plugin **must** contain exactly one. See the code below for an example. diff --git a/src/Impostor.Api/Events/Game/MeetingEndedEvent.cs b/src/Impostor.Api/Events/Meeting/MeetingEndedEvent.cs similarity index 90% rename from src/Impostor.Api/Events/Game/MeetingEndedEvent.cs rename to src/Impostor.Api/Events/Meeting/MeetingEndedEvent.cs index 01be941..2586c0b 100644 --- a/src/Impostor.Api/Events/Game/MeetingEndedEvent.cs +++ b/src/Impostor.Api/Events/Meeting/MeetingEndedEvent.cs @@ -1,7 +1,7 @@ using Impostor.Api.Games; using Impostor.Api.Net.Inner.Objects; -namespace Impostor.Api.Events +namespace Impostor.Api.Events.Meeting { public class MeetingEndedEvent : IEvent { diff --git a/src/Impostor.Api/Events/Game/MeetingStartedEvent.cs b/src/Impostor.Api/Events/Meeting/MeetingStartedEvent.cs similarity index 100% rename from src/Impostor.Api/Events/Game/MeetingStartedEvent.cs rename to src/Impostor.Api/Events/Meeting/MeetingStartedEvent.cs diff --git a/src/Impostor.Api/Events/Game/PlayerChatEvent.cs b/src/Impostor.Api/Events/Player/PlayerChatEvent.cs similarity index 92% rename from src/Impostor.Api/Events/Game/PlayerChatEvent.cs rename to src/Impostor.Api/Events/Player/PlayerChatEvent.cs index 1d70536..a5c62cd 100644 --- a/src/Impostor.Api/Events/Game/PlayerChatEvent.cs +++ b/src/Impostor.Api/Events/Player/PlayerChatEvent.cs @@ -1,7 +1,7 @@ using Impostor.Api.Games; using Impostor.Api.Net.Inner.Objects; -namespace Impostor.Api.Events +namespace Impostor.Api.Events.Player { public class PlayerChatEvent : IGameEvent { diff --git a/src/Impostor.Api/Events/Game/PlayerDestroyedEvent.cs b/src/Impostor.Api/Events/Player/PlayerDestroyedEvent.cs similarity index 91% rename from src/Impostor.Api/Events/Game/PlayerDestroyedEvent.cs rename to src/Impostor.Api/Events/Player/PlayerDestroyedEvent.cs index 6d5d8c4..fcbb562 100644 --- a/src/Impostor.Api/Events/Game/PlayerDestroyedEvent.cs +++ b/src/Impostor.Api/Events/Player/PlayerDestroyedEvent.cs @@ -1,7 +1,7 @@ using Impostor.Api.Games; using Impostor.Api.Net.Inner.Objects; -namespace Impostor.Api.Events.Net +namespace Impostor.Api.Events.Player { public class PlayerDestroyedEvent : IGameEvent { diff --git a/src/Impostor.Api/Events/Game/PlayerJoinedGameEvent.cs b/src/Impostor.Api/Events/Player/PlayerJoinedGameEvent.cs similarity index 90% rename from src/Impostor.Api/Events/Game/PlayerJoinedGameEvent.cs rename to src/Impostor.Api/Events/Player/PlayerJoinedGameEvent.cs index 3c165aa..236580b 100644 --- a/src/Impostor.Api/Events/Game/PlayerJoinedGameEvent.cs +++ b/src/Impostor.Api/Events/Player/PlayerJoinedGameEvent.cs @@ -1,7 +1,7 @@ using Impostor.Api.Games; using Impostor.Api.Net; -namespace Impostor.Api.Events +namespace Impostor.Api.Events.Player { public class PlayerJoinedGameEvent : IGameEvent { diff --git a/src/Impostor.Api/Events/Game/PlayerLeftGameEvent.cs b/src/Impostor.Api/Events/Player/PlayerLeftGameEvent.cs similarity index 91% rename from src/Impostor.Api/Events/Game/PlayerLeftGameEvent.cs rename to src/Impostor.Api/Events/Player/PlayerLeftGameEvent.cs index 5947ff2..925cab3 100644 --- a/src/Impostor.Api/Events/Game/PlayerLeftGameEvent.cs +++ b/src/Impostor.Api/Events/Player/PlayerLeftGameEvent.cs @@ -1,7 +1,7 @@ using Impostor.Api.Games; using Impostor.Api.Net; -namespace Impostor.Api.Events +namespace Impostor.Api.Events.Player { public class PlayerLeftGameEvent : IGameEvent { diff --git a/src/Impostor.Api/Events/Game/PlayerMovementEvent.cs b/src/Impostor.Api/Events/Player/PlayerMovementEvent.cs similarity index 85% rename from src/Impostor.Api/Events/Game/PlayerMovementEvent.cs rename to src/Impostor.Api/Events/Player/PlayerMovementEvent.cs index fd9238a..735328f 100644 --- a/src/Impostor.Api/Events/Game/PlayerMovementEvent.cs +++ b/src/Impostor.Api/Events/Player/PlayerMovementEvent.cs @@ -1,6 +1,6 @@ using Impostor.Api.Games; -namespace Impostor.Api.Events +namespace Impostor.Api.Events.Player { public class PlayerMovementEvent : IGameEvent { diff --git a/src/Impostor.Api/Events/Game/PlayerSpawnedEvent.cs b/src/Impostor.Api/Events/Player/PlayerSpawnedEvent.cs similarity index 91% rename from src/Impostor.Api/Events/Game/PlayerSpawnedEvent.cs rename to src/Impostor.Api/Events/Player/PlayerSpawnedEvent.cs index 9b1664a..5dcedd2 100644 --- a/src/Impostor.Api/Events/Game/PlayerSpawnedEvent.cs +++ b/src/Impostor.Api/Events/Player/PlayerSpawnedEvent.cs @@ -1,7 +1,7 @@ using Impostor.Api.Games; using Impostor.Api.Net.Inner.Objects; -namespace Impostor.Api.Events.Net +namespace Impostor.Api.Events.Player { public class PlayerSpawnedEvent : IGameEvent { diff --git a/src/Impostor.Plugins.Debugger/Pages/Index.razor b/src/Impostor.Plugins.Debugger/Pages/Index.razor index 4d53b08..5548dbb 100644 --- a/src/Impostor.Plugins.Debugger/Pages/Index.razor +++ b/src/Impostor.Plugins.Debugger/Pages/Index.razor @@ -3,6 +3,7 @@ @using Impostor.Api.Events.Managers @using Impostor.Api.Games.Managers @using Impostor.Api.Events +@using Impostor.Api.Events.Player @implements Impostor.Api.Events.IEventListener @inject IEventManager EventManager @inject IGameManager GameManager diff --git a/src/Impostor.Plugins.Example/Handlers/GameEventListener.cs b/src/Impostor.Plugins.Example/Handlers/GameEventListener.cs index 19d9bc4..89947aa 100644 --- a/src/Impostor.Plugins.Example/Handlers/GameEventListener.cs +++ b/src/Impostor.Plugins.Example/Handlers/GameEventListener.cs @@ -1,5 +1,6 @@ using System; using Impostor.Api.Events; +using Impostor.Api.Events.Player; namespace Impostor.Plugins.Example.Handlers { diff --git a/src/Impostor.Plugins.Example/Handlers/MeetingEventListener.cs b/src/Impostor.Plugins.Example/Handlers/MeetingEventListener.cs index 1b98c41..fffa3a5 100644 --- a/src/Impostor.Plugins.Example/Handlers/MeetingEventListener.cs +++ b/src/Impostor.Plugins.Example/Handlers/MeetingEventListener.cs @@ -1,5 +1,6 @@ using System; using Impostor.Api.Events; +using Impostor.Api.Events.Meeting; namespace Impostor.Plugins.Example.Handlers { diff --git a/src/Impostor.Plugins.Example/Handlers/PlayerEventListener.cs b/src/Impostor.Plugins.Example/Handlers/PlayerEventListener.cs index eaaf833..50536a8 100644 --- a/src/Impostor.Plugins.Example/Handlers/PlayerEventListener.cs +++ b/src/Impostor.Plugins.Example/Handlers/PlayerEventListener.cs @@ -1,7 +1,7 @@ using System; using System.Threading.Tasks; using Impostor.Api.Events; -using Impostor.Api.Events.Net; +using Impostor.Api.Events.Player; namespace Impostor.Plugins.Example.Handlers { diff --git a/src/Impostor.Plugins.Example/Impostor.Plugins.Example.csproj b/src/Impostor.Plugins.Example/Impostor.Plugins.Example.csproj index 0cd6cd5..d72de82 100644 --- a/src/Impostor.Plugins.Example/Impostor.Plugins.Example.csproj +++ b/src/Impostor.Plugins.Example/Impostor.Plugins.Example.csproj @@ -3,7 +3,7 @@ netstandard2.1 - + diff --git a/src/Impostor.Server/Net/Inner/Objects/InnerMeetingHud.cs b/src/Impostor.Server/Net/Inner/Objects/InnerMeetingHud.cs index 6a83227..29a803b 100644 --- a/src/Impostor.Server/Net/Inner/Objects/InnerMeetingHud.cs +++ b/src/Impostor.Server/Net/Inner/Objects/InnerMeetingHud.cs @@ -4,6 +4,7 @@ using System.Threading.Tasks; using Impostor.Api; using Impostor.Api.Events; using Impostor.Api.Events.Managers; +using Impostor.Api.Events.Meeting; using Impostor.Api.Net; using Impostor.Api.Net.Messages; using Impostor.Server.Net.State; diff --git a/src/Impostor.Server/Net/Inner/Objects/InnerPlayerControl.cs b/src/Impostor.Server/Net/Inner/Objects/InnerPlayerControl.cs index 0d6f39b..458d4bd 100644 --- a/src/Impostor.Server/Net/Inner/Objects/InnerPlayerControl.cs +++ b/src/Impostor.Server/Net/Inner/Objects/InnerPlayerControl.cs @@ -3,7 +3,7 @@ using System.Threading.Tasks; using Impostor.Api; using Impostor.Api.Events; using Impostor.Api.Events.Managers; -using Impostor.Api.Events.Net; +using Impostor.Api.Events.Player; using Impostor.Api.Innersloth; using Impostor.Api.Net; using Impostor.Api.Net.Inner.Objects; diff --git a/src/Impostor.Server/Net/State/Game.Data.cs b/src/Impostor.Server/Net/State/Game.Data.cs index 29d2069..32cff8b 100644 --- a/src/Impostor.Server/Net/State/Game.Data.cs +++ b/src/Impostor.Server/Net/State/Game.Data.cs @@ -4,7 +4,7 @@ using System.Threading; using System.Threading.Tasks; using Impostor.Api; using Impostor.Api.Events; -using Impostor.Api.Events.Net; +using Impostor.Api.Events.Player; using Impostor.Api.Innersloth; using Impostor.Api.Net.Messages; using Impostor.Api.Net.Messages.S2C; diff --git a/src/Impostor.Server/Net/State/Game.State.cs b/src/Impostor.Server/Net/State/Game.State.cs index e51b2f7..c53a3d4 100644 --- a/src/Impostor.Server/Net/State/Game.State.cs +++ b/src/Impostor.Server/Net/State/Game.State.cs @@ -2,6 +2,7 @@ using System.Threading.Tasks; using Impostor.Api; using Impostor.Api.Events; +using Impostor.Api.Events.Player; using Impostor.Api.Innersloth; using Impostor.Api.Net; using Impostor.Api.Net.Messages; -- 2.39.5