A collection of design patterns for solving common problems.
The word Valid was spelt incorrectly.
The custom Observable List Editor should also be blocked if the ZINNIA_IGNORE_CUSTOM_INSPECTOR_EDITOR ifdef is set otherwise it will throw an error becaue it will try and inherit from a class that does not get created in those circumstances.
The PointsCast now has a RaycastHitValidity rule that will allow any data within the cast RaycastHit to be used within a rule for any custom.
The Drag Curve Offset is now a Vector3 allowing the curve offset to be applied to any axis rather than just the back axis.
To replicate the orignal setting, just change the Z axis to a negative value and this will replicate the same as the Vector3.back * offset.
The custom collapisble drawer editor modification can now be disabled by setting a scripting define symbol of
ZINNIA_IGNORE_CUSTOM_COLLAPSIBLE_DRAWER.
The various script define symbols that are added by Zinnia are now documented to make it easier to know when to use them.
The TransformPositionDifferenceRotation logic now has a source to offset maximum distance setting that will be activated if the
Apply Offsetis to true. This will ensure the rotation will only be applied when the source and offset are within the given distances and anything outside of those distances will be ignored.
Due to a change in Unity 2022.3, there is now no actual need to do the reflection for replacing a default drawer and in fact the attempt to get
DrawerKeySetwill return a null, thus causing the existing error.The fix is to simply do a null check to prevent the error and the reflection will simply be ignored on versions of Unity of 2022.3 and above.
The EmitEvents property can be unchecked to prevent any action events from being emitted when action values are changed.
There are also two new methods
ResetToInitialValueandResetToDefaultValuethat will reset an Action value to its default or inital value without calling any events either.
The TransformPropertyApplier now has an AllowMutate property the same as the TransformPropertyMutator, which can be used to prevent mutations occurring and will raise a skipped event if mutations are turned off.
The before update event is always raised.
The TransformPropertyMutator now emits an event on pre mutation with the value that it is going to mutate the target to. It also emits an event when the mutation has occurred with this new value.
It is also possible to prevent a mutation from occuring by setting the new Allow Mutation boolean property, which will still do the pre mutation event but will then skip the actual mutation of the target and not raise the post mutation event, but instead raise a mutation skipped event.
This makes it possible to check to see if a property mutation will provide an undesired result in the pre mutation and then prevent the mutation from occuring by turning off the Allow Mutation.
Some refactoring of the internal calls has been done too so it is cleaner and less code repetition.
The PipelineMaterialApplier component now has another option to determine what render pipeline is being used. The default Pipeline Shader name can also be provided to determine which render pipeline is active as sometimes the name is not robust enough as it can be renamed in the settings.
The state of the pointer is now cleared on enable and disable to ensure it is in the correct state.
The HasIsConnectedChange event now starts with a null state to ensure if the event is false by default then it at least will raise the connected event and toggle the state.
There is also a test now for the BaseDeviceDetailsRecord.
There can be an error when the current forward is Vector3.zero and this value is then used to try and set the renderElement forward and causes an error. So this prevents that from happening.
The PointsCast now has a cursor lock function and a transition duration which allows the cursor to be locked to a location until the pointer moves a certain threshold distance away when the cursor location will then be updated, this can be used to prevent jittering or keep a solid lock on an object. The transition duration allows the pointer destination cursor to transition over time to the new destination providing a smoothing feature for the pointer cursor.
The FixedLineCast has now been deprecated as the StraightLineCast now handles the concept of being a fixed line as it's basically the same thing and makes it more complex to implement functionality that is shared between the two concepts.
The StraightLineCast now has the ability to fix the line at a set length and optionally ignore any new targets once fixed.
Along with the cursor lock and transition duration, it's also possible to apply a drag effect to the straight line where the straight line actually bends to try and keep the straight line from the origin to the offset destination.
The PointsCastEventProxyEmitter allows Points Cast data to be proxied.
The Vector3State type now has additional short hand initialisers like XYOnly, XZOnly and YZOnly.
The GameObjectRelationsEventProxyEmitter makes it possible to proxy events containing the GameObjectRelations Payload.
A Direction extension method for Vector2 and Vector3 will get the direction vector between a source point and a target point.
The PinchScaler component can now have min/max scale limits applied to it as well as limiting the axes that will be scaled.
A new component that allows to extract the collision notifier event data from the event data of the Active Collision Consumer.
The Notifier Target Extractor also has the option now to get the absolute collider object or the compound parent (as was the original) functionality.
The mechanism within the ScenePipelineMaterialApplier uses the
FindObjectsOfTypemethod that in Unity 2019.2 had the additional parameter offindInactiveadded, which is required for this functionality to work.However, in Unity 2019.4 this parameter is randomly removed, probably due to poor quality control from Unity, so this means that this functionality works in 2019.2, 2019.3 but throws an error in 2019.4.
The feature is reintroduced in 2020.1, so the fix is just to support this functionality in 2020.1 as Unity won't back port a fix.
The PipelineMaterialApplier will set the Materials on a given Renderer based on the current render pipeline being used. It gets the materials to apply from a given list of materials that has a string group name that matches the desired render pipeline name.
If no render pipeline is provided then the matched name will be:
defaultThere is also an editor menu item that will attempt to find all PipelineMaterialApplier components in the scene and run them to ensure all materials on the renderers are updated to match the current render pipeline.
It would seem that the behaviour.isActiveAndEnabled property does not always return what is expected. If a GameObject is active and the behaviour is enabled then isActiveAndEnabled can still return false whilst in the OnEnable state.
It would seem that isActiveAndEnabled does not return true until all of the relevant initial Unity moments have passed for an Object.
To counter this, a new BehaviourExtension has been added called
CheckIsActiveAndEnabled()that will do an absolute check on the GameObject active state and the behaviour enabled state.If the old isActiveAndEnabled check is still required then it can be switched to by a scripting define symbol of:
ZINNIA_USE_ISACTIVEANDENABLEDAll of the relevant files that use
isActiveAndEnabledhave now been updated to use the newCheckIsActiveAndEnabled()extension method.
The new SetPassThrough method will simply call the relevant passthrough method based on the current PassThroughCameraEnabled value.
This is useful if the passthrough camera has turned off due to application pause and needs returning back on when the app is unpaused.