Adding TempVisualEffectAPI #313
Merged
Conversation
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
Allows for adding custom TemporaryVisualEffects (TVEs) to every CharacterBody spawned that functions the same as vanilla TVEs. Use `TempVisualEffectAPI.AddTemporaryVisualEffect()` before `WhenContentPackLoaded` to add a custom TVE to a static List and Dictionary. Custom TVE list is copied into `R2APITVEController` components which are added on `CharacterBody.onBodyStartGlobal`. Hooks onto CharacterBody's `UpdateAllTemporaryVisualEffects()` and `UpdateSingleTemporaryVisualEffect` to update custom TVEs just like vanilla ones. Compares the latter method's `resourceString` input with the dictionary's string key in order to instantiate the correct TVE GameObject. `AddTemporaryVisualEffect()` requires a CharacterBody input, bool output delegate parameter. This delegate is used for the 'active' of the TVE - if it returns true, the TVE will be created/activated for the instance.
xiaoxiao921
requested changes
Nov 25, 2021
R2API/TempVisualEffectAPI.cs
Outdated
| if (controller) { | ||
| for (int i = 0; i < controller.localTVEs.Count; i++) { | ||
| TempVisualEffectAPI.TemporaryVisualEffectStruct temp = controller.localTVEs[i]; | ||
| self.UpdateSingleTemporaryVisualEffect(ref temp.effect, moddedString + temp.effectPrefab.name, temp.useBestFitRadius ? self.radius : self.bestFitRadius, temp.condition.Invoke(self), temp.childLocatorOverride); |
There was a problem hiding this comment.
Use effectName not .name so that garbage isnt generated each frame
R2API/TempVisualEffectAPI.cs
Outdated
| private static void UpdateSingleHook(ILContext il) { | ||
| var cursor = new ILCursor(il); | ||
|
|
||
| GameObject GetCustomTVE(GameObject vanillaLoaded, string ResourceString) |
There was a problem hiding this comment.
resourceString not ResourceString
R2API/TempVisualEffectAPI.cs
Outdated
| var newTVE = new TemporaryVisualEffectStruct(); | ||
|
|
||
| if (effectPrefab == null) { | ||
| R2API.Logger.LogError($"Tried to add TVE: {effectPrefab.name} GameObject is null"); return false; |
There was a problem hiding this comment.
.name will fail here since ref is null
R2API/TempVisualEffectAPI.cs
Outdated
| newTVE.effectName = effectPrefab.name; | ||
|
|
||
| tves.Add(newTVE); | ||
| tveDict.Add(moddedString + effectPrefab.name, newTVE); |
R2API/TempVisualEffectAPI.cs
Outdated
|
|
||
| internal static List<TemporaryVisualEffectStruct> tves = new List<TemporaryVisualEffectStruct>(); | ||
| internal static Dictionary<string, TemporaryVisualEffectStruct> tveDict = new Dictionary<string, TemporaryVisualEffectStruct>(); | ||
| internal static readonly string moddedString = "R2APIModded:"; |
Fixed based on the Pull Request review from `xiaoxiao921`. Thank you for the review and suggesting changes! I've implemented the suggested changes and some extras: - Reorganised the checks, such as checking if the effectPrefab is null first. - `GameObject == null` now throws NRE instead of returns false. - Removed `effect.effectPrefab == effectPrefab` check. Matching GameObjects can be added, as long as the name is different (For using the same effect but in a different radius, condition, or child locator). - Changed 'Tried' to 'Failed'. More accurate.
xiaoxiao921
approved these changes
Nov 25, 2021
Updated `useBestFitRadius` to default to false, making `effectPrefab` and `condition` the only required parameters.
Whoops, had the API named wrong.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Allows for adding custom TemporaryVisualEffects (TVEs) to every CharacterBody spawned that functions the same as vanilla TVEs.
Use
TempVisualEffectAPI.AddTemporaryVisualEffect()beforeWhenContentPackLoaded(usually in mod'sAwake()) to add a custom TVE to a static List and Dictionary. Custom TVE list is copied intoR2APITVEControllercomponents which are added onCharacterBody.onBodyStartGlobal. Hooks onto CharacterBody'sUpdateAllTemporaryVisualEffects()andUpdateSingleTemporaryVisualEffect()to update custom TVEs just like vanilla ones. Compares the latter method'sresourceStringinput with the dictionary's string key in order to instantiate the correct TVE GameObject.AddTemporaryVisualEffect()requires a CharacterBody input, bool output delegate parameter. This delegate is used for the 'active' of the TVE - if it returns true, the TVE will be created/activated for the instance.Example use:
