diff --git a/Directory.Build.props b/Directory.Build.props index b0733cc..192a6eb 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -12,6 +12,6 @@ It should follow the format major.minor.patch (semantic versioning). If you publish your mod as a library to NuGet, this version will also be used as the package version. --> - 0.3.8 + 0.3.9 diff --git a/README.md b/README.md index f98e83d..1d54b70 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ This is a library for mods to make FSM edits easier. To add Silksong.FsmUtil to your mod, add the following line to your .csproj: ``` - + ``` The most up to date version number can be retrieved from [Nuget](https://www.nuget.org/packages/Silksong.FsmUtil). You will also need to add a dependency to your thunderstore.toml: ``` -silksong_modding-FsmUtil = "0.3.8" +silksong_modding-FsmUtil = "0.3.9" ``` The version number does not matter hugely, but the most up to date number can be retrieved from [Thunderstore](https://thunderstore.io/c/hollow-knight-silksong/p/silksong_modding/FsmUtil/). diff --git a/docs/index.md b/docs/index.md index f057abc..84342f8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,13 +12,13 @@ With this, it's easy to: To add Silksong.FsmUtil to your mod, add the following line to your .csproj: ``` - + ``` The most up to date version number can be retrieved from [Nuget](https://www.nuget.org/packages/Silksong.FsmUtil). You will also need to add a dependency to your thunderstore.toml: ``` -silksong_modding-FsmUtil = "0.3.8" +silksong_modding-FsmUtil = "0.3.9" ``` The version number does not matter hugely, but the most up to date number can be retrieved from [Thunderstore](https://thunderstore.io/c/hollow-knight-silksong/p/silksong_modding/FsmUtil/). diff --git a/src/FsmUtil.cs b/src/FsmUtil.cs index 8fe41f7..34ca76b 100644 --- a/src/FsmUtil.cs +++ b/src/FsmUtil.cs @@ -453,19 +453,16 @@ public static void AddActions(this FsmState state, params FsmStateAction[] actio /// The name of the state in which the method is added /// The method that will be invoked with the action as the parameter [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `AddLambdaMethod` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void AddMethod(this PlayMakerFSM fsm, string stateName, Action method) => fsm.GetState(stateName)!.AddMethod(method); /// [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `AddLambdaMethod` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void AddMethod(this Fsm fsm, string stateName, Action method) => fsm.GetState(stateName)!.AddMethod(method); /// /// The fsm state /// The method that will be invoked with the action as the parameter [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `AddLambdaMethod` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void AddMethod(this FsmState state, Action method) { DelegateAction action = new DelegateAction { Method = method }; @@ -481,21 +478,18 @@ public static void AddMethod(this FsmState state, Action method) /// The method that will be invoked /// If true, execute the function repeatedly on every update frame [PublicAPI] - [Obsolete("In a future update, this method will be `AddMethod`.")] - public static void AddMethod2(this PlayMakerFSM fsm, string stateName, Action method, bool everyFrame = false) => fsm.GetState(stateName)!.AddMethod2(method, everyFrame); + public static void AddMethod(this PlayMakerFSM fsm, string stateName, Action method, bool everyFrame = false) => fsm.GetState(stateName)!.AddMethod(method, everyFrame); - /// + /// [PublicAPI] - [Obsolete("In a future update, this method will be `AddMethod`.")] - public static void AddMethod2(this Fsm fsm, string stateName, Action method, bool everyFrame = false) => fsm.GetState(stateName)!.AddMethod2(method, everyFrame); + public static void AddMethod(this Fsm fsm, string stateName, Action method, bool everyFrame = false) => fsm.GetState(stateName)!.AddMethod(method, everyFrame); - /// + /// /// The fsm state /// The method that will be invoked /// If true, execute the function repeatedly on every update frame [PublicAPI] - [Obsolete("In a future update, this method will be `AddMethod`.")] - public static void AddMethod2(this FsmState state, Action method, bool everyFrame = false) + public static void AddMethod(this FsmState state, Action method, bool everyFrame = false) { LambdaAction action = new LambdaAction { Method = method }; state.AddAction(action); @@ -630,22 +624,18 @@ public static void InsertActions(this FsmState state, int index, params FsmState /// The index to place the action in /// bool that indicates whether the insertion was successful [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `InsertLambdaMethod` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void InsertMethod(this PlayMakerFSM fsm, string stateName, Action method, int index) => fsm.GetState(stateName)!.InsertMethod(index, method); /// [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `InsertLambdaMethod` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void InsertMethod(this PlayMakerFSM fsm, string stateName, int index, Action method) => fsm.GetState(stateName)!.InsertMethod(index, method); /// [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `InsertLambdaMethod` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void InsertMethod(this Fsm fsm, string stateName, Action method, int index) => fsm.GetState(stateName)!.InsertMethod(index, method); /// [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `InsertLambdaMethod` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void InsertMethod(this Fsm fsm, string stateName, int index, Action method) => fsm.GetState(stateName)!.InsertMethod(index, method); /// @@ -653,12 +643,10 @@ public static void InsertActions(this FsmState state, int index, params FsmState /// The method that will be invoked /// The index to place the action in [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `InsertLambdaMethod` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void InsertMethod(this FsmState state, Action method, int index) => state.InsertMethod(index, method); /// [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `InsertLambdaMethod` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void InsertMethod(this FsmState state, int index, Action method) { DelegateAction action = new DelegateAction { Method = method }; @@ -676,36 +664,30 @@ public static void InsertMethod(this FsmState state, int index, ActionThe index to place the action in /// bool that indicates whether the insertion was successful [PublicAPI] - [Obsolete("In a future update, this method will be `InsertMethod`.")] - public static void InsertMethod2(this PlayMakerFSM fsm, string stateName, Action method, int index, bool everyFrame = false) => fsm.GetState(stateName)!.InsertMethod2(index, method, everyFrame); + public static void InsertMethod(this PlayMakerFSM fsm, string stateName, Action method, int index, bool everyFrame = false) => fsm.GetState(stateName)!.InsertMethod(index, method, everyFrame); - /// + /// [PublicAPI] - [Obsolete("In a future update, this method will be `InsertMethod`.")] - public static void InsertMethod2(this PlayMakerFSM fsm, string stateName, int index, Action method, bool everyFrame = false) => fsm.GetState(stateName)!.InsertMethod2(index, method, everyFrame); + public static void InsertMethod(this PlayMakerFSM fsm, string stateName, int index, Action method, bool everyFrame = false) => fsm.GetState(stateName)!.InsertMethod(index, method, everyFrame); - /// + /// [PublicAPI] - [Obsolete("In a future update, this method will be `InsertMethod`.")] - public static void InsertMethod2(this Fsm fsm, string stateName, Action method, int index, bool everyFrame = false) => fsm.GetState(stateName)!.InsertMethod2(index, method, everyFrame); + public static void InsertMethod(this Fsm fsm, string stateName, Action method, int index, bool everyFrame = false) => fsm.GetState(stateName)!.InsertMethod(index, method, everyFrame); - /// + /// [PublicAPI] - [Obsolete("In a future update, this method will be `InsertMethod`.")] - public static void InsertMethod2(this Fsm fsm, string stateName, int index, Action method, bool everyFrame = false) => fsm.GetState(stateName)!.InsertMethod2(index, method, everyFrame); + public static void InsertMethod(this Fsm fsm, string stateName, int index, Action method, bool everyFrame = false) => fsm.GetState(stateName)!.InsertMethod(index, method, everyFrame); - /// + /// /// The fsm state /// The method that will be invoked /// The index to place the action in [PublicAPI] - [Obsolete("In a future update, this method will be `InsertMethod`.")] - public static void InsertMethod2(this FsmState state, Action method, int index, bool everyFrame = false) => state.InsertMethod2(index, method, everyFrame); + public static void InsertMethod(this FsmState state, Action method, int index, bool everyFrame = false) => state.InsertMethod(index, method, everyFrame); - /// + /// [PublicAPI] - [Obsolete("In a future update, this method will be `InsertMethod`.")] - public static void InsertMethod2(this FsmState state, int index, Action method, bool everyFrame = false) + public static void InsertMethod(this FsmState state, int index, Action method, bool everyFrame = false) { LambdaAction action = new LambdaAction { Method = method }; state.InsertAction(action, index); @@ -757,7 +739,6 @@ public static void InsertLambdaMethod(this FsmState state, int index, ActionThe action to insert before. /// The method to execute. The argument will be the FsmStateAction which is being added. [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `InsertLambdaMethodBefore` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void InsertMethodBefore(this FsmStateAction action, Action method) { FsmState state = action.State; @@ -771,7 +752,6 @@ public static void InsertMethodBefore(this FsmStateAction action, ActionThe action to insert after. /// The method to execute. The argument will be the FsmStateAction which is being added. [PublicAPI] - [Obsolete("In a future update, the method here will no longer take a parameter. Please use the `InserLambdatMethodAfter` extension method instead! (Though that one's parameter is the `Finish` method.)")] public static void InsertMethodAfter(this FsmStateAction action, Action method) { FsmState state = action.State; @@ -785,12 +765,11 @@ public static void InsertMethodAfter(this FsmStateAction action, ActionThe action to insert before. /// The method to execute. [PublicAPI] - [Obsolete("In a future update, this method will be `InsertMethodBefore`.")] - public static void InsertMethod2Before(this FsmStateAction action, Action method) + public static void InsertMethodBefore(this FsmStateAction action, Action method) { FsmState state = action.State; int idx = Array.IndexOf(state.Actions, action); - state.InsertMethod2(idx, method); + state.InsertMethod(idx, method); } /// @@ -799,12 +778,11 @@ public static void InsertMethod2Before(this FsmStateAction action, Action method /// The action to insert after. /// The method to execute. [PublicAPI] - [Obsolete("In a future update, this method will be `InsertMethodAfter`.")] - public static void InsertMethod2After(this FsmStateAction action, Action method) + public static void InsertMethodAfter(this FsmStateAction action, Action method) { FsmState state = action.State; int idx = Array.IndexOf(state.Actions, action); - state.InsertMethod2(idx + 1, method); + state.InsertMethod(idx + 1, method); } /// diff --git a/thunderstore/thunderstore.toml b/thunderstore/thunderstore.toml index 5b46dfc..69dfa8c 100644 --- a/thunderstore/thunderstore.toml +++ b/thunderstore/thunderstore.toml @@ -1,5 +1,5 @@ [config] -schemaVersion = "0.3.8" +schemaVersion = "0.3.9" [package] # The name of the team you are publishing as