4.1.1

[4.1.1] - 2024-06-17

Compare: 4.1.0...4.1.1

Fixed

• Fixed mistakes in README.

4.1.0

[4.1.0] - 2024-06-16

Compare: 4.0.0...4.1.0

Added

• SceneReferenceUnityEventAdapter class: A utility MonoBehaviour that allows using statically provided SceneReferences as parameters to a UnityEvent.
• Utility Ignores: A set of settings that allow ignoring certain scenes from having the inline utilities.

4.0.0

Compare: 3.2.1...4.0.0

[4.0.0] - 2024-01-23

There are fundamental changes to the editor-time behaviour in this release. Please examine carefully before upgrading.

Breaking Changes

• From now on, map files are only generated during a build, and removed right after. In editor-time, maps are instead stored in and fetched from User Settings. You can remove the generated files and folders from your project, and remove the corresponding lines from your source control's ignore settings.
• SceneDataMapsGenerator.Run now takes a booelan argument that controls whether to ouput files or not.
• Minimum compatible Unity version is set to 2020.3.48f1.

Changed

• Default value of EditorLogLevel setting is now Warning, it was previously Debug.
• Default value of JsonFormatting setting is now None, it was previously Indented.

Fixed

• Prevent null ref exceptions during runtime caused by uninitialized map providers when the maps are missing.

3.2.1

Compare: 3.2.0...3.2.1

[3.2.1] - 2023-12-27

Fixed

• Prevent Scene GUID to path map file not found! errors and null reference exceptions in SceneAssetPostprocessor if the scene GUID to path map file is missing.
• Prevent null reference exceptions at project launch due to addressables settings not being loaded yet.
• Ensure map files are always generated at editor startup, even if they are empty.

3.2.0

Compare: 3.1.3...3.2.0

[3.2.0] - 2023-11-20

Added

• SceneReference.UnsafeReason property: Provides the reasoning behind why a SceneReference was deemed unsafe.
• SceneReferenceUnsafeReason enum: Possible reasons for a SceneReference to be deemed unsafe.

Fixed

• SceneDataMapsGenerator no longer runs on scene saves.

3.1.3

Compare: 3.1.2...3.1.3

[3.1.3] - 2023-11-12

Fixed

• Prevent null reference errors when addressables package is installed, but addressables settings are not initialized.

3.1.2

Compare: 3.1.1...3.1.2

Thanks to @Ale1 for their contribution (#75).

[3.1.2] - 2023-11-12

Fixed

• Backwards compatibility: Use EditorStyles.miniButton instead of non-existent EditorStyles.iconButton for Unity versions earlier than 2022.1.

3.1.1

Compare: 3.1.0...3.1.1

[3.1.1] - 2023-07-22

Fixed

• Implemented workaround for a Unity bug that caused our settings page to throw exceptions and not display in Unity 2022.3.4f1.

3.1.0

Compare: 3.0.0...3.1.0

[3.1.0] - 2023-07-08

Added

• Log level of the editor logger can now be controlled with the new setting Logging/Editor Log Level.

Removed

• Removed the suggestion to output generated files as indented for source control reasons. This is because we are suggesting to ignore the generated files.

3.0.0

Compare: 2.1.0...3.0.0

[3.0.0] - 2023-07-07

This release introduces support for addressable scenes.

There are breaking changes to settings. Please visit the settings page and re-apply all your settings as soon as you update.

Breaking Changes

• SceneGuidToPathMapGenerator is renamed to SceneDataMapsGenerator.
• SceneGuidToPathMapGenerationTriggers is renamed to SceneDataMapsGeneratorTriggers.
• Settings changes:
  • Scene GUID to Path Map (new name Scene Data Maps) category:
    • The category is renamed from SceneGuidToPathMap to SceneDataMaps.
    • Key of the GenerationTriggers setting is changed from SceneGuidToPathMap.GenerationTriggers to SceneDataMaps.GenerationTriggers.
    • Key of the JsonFormatting setting is changed from SceneGuidToPathMap.JsonFormatting to SceneDataMaps.JsonFormatting.
    • Key of the FailBuildIfGenerationFails setting is changed from SceneGuidToPathMap.FailBuildIfGenerationFails to SceneDataMaps.FailBuildIfGenerationFails.
  • Property Drawer category:
    • ShowInlineSceneInBuildUtility setting is renamed to ShowInlineToolbox. The key is also changed from PropertyDrawer.ShowInlineSceneInBuildUtility to PropertyDrawer.ShowInlineToolbox.
• All exceptions are moved from the Eflatun.SceneReference namespace to the new Eflatun.SceneReference.Exceptions namespace.
• Following valiation properties are removed from SceneReference. They are instead replaced with a more informative State property. See the Added section.
  • IsInSceneGuidToPathMap: removed.
  • IsInBuildAndEnabled: removed.
  • IsSafeToUse: removed.
  • HasValue: no longer public.
• SceneReferenceOptionsAttribute changes:
  • Coloring field is renamed to SceneInBuildColoring. It still controls the same cases of coloring, but they are no longer all the coloring options. See the Changes section.
  • UtilityLine field is removed. Its replacement is the Toolbox field. See the Added section.

Added

• SceneDataMapsGenerator now also generates a scene GUID to address map. The map will be empty if addressables support is disabled.
• New map generation triggers:
  • AfterPackagesResolve: Triggers after packages are resolved.
  • AfterAddressablesChange: Triggers after addressable groups change.
• Property drawer can optionally color addressables scenes differently to draw attention to them.
• New inline utilties:
  • Make Addressable: Makes the scene addressable.
• New settings:
  • Addressables Support (AddressablesSupport) category:
    • ColorAddressableScenes setting: If enabled, scene references that have an addressable scene will be colored differently.
    • An info box that displays the current addressables support status.
• New exceptions:
  • AddressNotFoundException
  • AddressNotUniqueException
  • AddressablesSupportDisabledException
  • SceneNotAddressableException
• SceneGuidToAddressMapProvider class: Provides a map of scene GUIDs to their address. Very similar to SceneGuidToPathMapProvider, with the exception that it cannot provide an inverse map. This is because the address of an asset is not guaranteed to be unique. Instead, it provides GetGuidFromAddress and TryGetGuidFromAddress methods.
• SceneReference.FromAddress factory method: Creates a SceneReference from the given address.
• SceneReference.Address property.
• SceneReference.State property: This property replaces all previously exposed validation methods. It returns a SceneReferenceState enum, which describes the state of the SceneReference in terms of usage.
• SceneReferenceState enum: Describes the state of the SceneReference in terms of usage.
  • Unsafe: The SceneReference is not safe to use.
  • Regular: The SceneReference is safe to use, and it references a regular scene.
  • Addressable: The SceneReference is safe to use, and it references an addressable scene. This state is only possible if addressables support is enabled.
• SceneReferenceOptionsAttribute new fields:
  • Toolbox: Controls the visibility of the toolbox button. It replaces the now deleted UtilityLine field.
  • AddressableColoring: Controls the coloring behaviour of the addressable scenes.
• ToolboxBehaviour enum. Replaces the now deleted UtilityLineBehaviour enum with the same semantics.

Changed

• The concept of Utility Line is replaced with the concept of Toolbox. In summary, instead of drawing buttons as a second line below the field, we instead draw a small button to the end of the field on the same line. When clicked, a toolbox popup appears with all the utilities.
• SceneInBuildColoring argument (previously named Coloring) of SceneReferenceOptionsAttribute still controls the same types of coloring cases, but since they used to be all the cases, the field was implicitly controlling the entire coloring behaviour. While its semantics are not changed, since there are now other coloring cases, it is no longer the only field that controls the entire coloring behaviour.