Patch Notes - V1.7

Version 1.7 - May 2024 (CURRENT)

• Upgraded all default Unity UI elements to TextMeshPro for better performance, customisation and clarity

  • Updated all scripts for TMP integration

• Added brand new persistence bool so you can specify if you want to keep managers / singletons between scenes

• ExaminableItem

  • Added brand new null checks if font or audios are missing for better usage

• ExamineInteractor

  • Added a new reference check into the so we can always find the camera object

• ExamineUIManager

  • Added brand new FieldNullCheck() method which will report if any references are missing at the start of your game, to avoid null ref errors

  • This parent now holds all UI elements so we can make these persist between scenes more easily

Version 1.6 - August 2023

• Updated all colliders for inspect style objects to show basic setups

• Duplicated all scripts to fix GUID issues with duplications

• Renamed all UI elements for easier reading and consistency

• Refactored ExamineUIManager script

  • Added new functionality for disabling help prompt

  • Removed public field from the script

  • Added CanvasGroup functionality to Name Highlight Canvas

• Refactored ExaminableItem script

  • Added the ability to lerp the position of the item to make a smoother transition

• Made Sound script generic because it's shared with my other assets

• Added note to disable manager about the player reference

• Editor folder is now in the root directory of the Examine System folder to fix build issues

Version 1.5 - September 2022

• Added Invert option for Rotation of objects during interaction

• Renamed Raycast Script to ExamineInteractor for easier understanding

  • Updated to V2022

• All inspect points now have custom sounds that can be added to each interaction

  • Added an animation example to the demo scene

• Created ScriptableObjects for all sounds effects

  • Updated AudioManager for new update

• Decoupled parts of the Disable Manager for easier editing and removing parts

  • Added crosshair reference to only the UI Manager

  • Added cursor hiding to UI Manager

• Updated UI design and text visuals to be more modern

• Refactored entire ExaminableItem script

  • Renamed ExamineItemController to ExaminableItem

  • Decoupled UI elements from the ExamineItemController to the UIManager

• Added UI Crosshair to UI Manager script from the Raycast

• Added a new Drop Sound option in each ExaminableItem Script

• Added ShowUIHelp boolean to UI Manager

• Added a range of new sound effects to the package

• Restructured Demo Scene for easy sorting and understanding

• Renamed all Models, Textures, UI Icons and extras

• Resized all models to re-world units

Version 1.4.3

• Updated online documentation & included PDF to match with all affected changes

• Added a "GameObject Tag Reference" page so the objects which need specific setup can be referenced

• Refactored the "ExamineItemController" script and added a collapsable "TextCustomisation" for variables to keep the inspector clean

• Added HDRP videos, examples and blur effects

Version 1.4.2

• Fixed an issue where adding "Walls" or an exclude layer would cause issues with object interaction, now no tags or layers are needed on a per object basis. ONLY: Layers of "ExamineLayer" & "InspectPointLayer" are required

• Changed the name of "InspectPointMask" to "InspectPointLayer" for consistency

• Removed some redudant code from the "RaycastManager" and "ItemController" script to reflect these changes

• Added the ability to change the position of the object, on the horizontal axis so you can move it around the screen

• Added a vertical offet to the system to control how far the object should appear up or down, based on your settings

• Added a boolean to show the "Help UI" on a per object basis. Update the "HelpPanel" elements to change the look and feel of the help prompts

Version 1.4.1 (CURRENT)

• Added a mention to the FAQ about pivot points to explain how to easily solve an issue with objects not rotating as you'd expect!

• If objects have children - Added an array to make sure all children change and all emission changes too

• Created a boolean to tick, if the object is an empty parent - Meaning you will get less errors regarding emission

Version 1.4.0 - April 2021

• New Features:

  • New variable in the inspector so sound names can easily be added from the "AudioManager"

    • Various sounds effects added for examine interaction sounds

  • Custom text highlight near the cursor to tell you item name and interaction information

    • Custom interaction toggle for both emission highlight and item name highlight

    • Custom Canvas created to modify: Images, text and prompts!

    • Added objects to the "UI Manager" so these only need to be linked once

  • Addition of inspection points to give the system more depth

    • Only become visible when interacting

  • Custom Events - So more things can happen when interacting with an object

    • Custom event interaction when selecting items

    • Lid removal on box example script

    • Key pickup example script

• Minor Fixes:

  • Changed both "MainCamera" and "ExaminePoint" variables so they're found automatically "OnStart()" rather than adding them yourself

  • Refactored the script and re-ordered variables

  • New test scene with more explanations, examples and presentation

Version 1.3.1 - March 2021

• Created online documentation

• Updated included documentation for adding a new controller and general tweaks

• Reduced file size of the package by removing light-baked data

Version 1.3 – November 2020

• Added a close button within the UI, so the examine can be dropped using a button

• Set the distance the item is from the camera, based on a value in the inspector

• Set the starting rotation of an object with an X, Y, Z value in the inspector

• Zoom in and out of the object using the scrollwheel

• Set zooming bounds with between 2 values

• Added Text: Size, Font, Style and Color variables in the inspector to easily customise the UI’s on a per asset basis

• Added the built in “OnDestroy” method to make sure objects destroy material instances upon leaving the scene (To avoid memory leaks)

• Added the “ExcludeLayer” to the raycast to ensure users can negate raycasts through other objects

• Connected the “UIManager” to the “ExamineItemScript” to avoid any extra setup

• Refactored the “ExamineItemScript” for refined code and ease of use

Version 1.2 – July 2020

• Scripting Changes

  • Updated the Examine Controller to incorporate a one script setup

  • Added a new Audio Manager, so more sounds can be added and called within script

  • Added a new input manager, which allows easy control of all inputs from one place

  • Refactored the Raycast, ExamineController and more!

• Miscellaneous

  • Updated and edited sounds, textures and materials

  • Added new manager examples to the prefabs and demo scene

  • Update all prefabs and set them to 0, 0, 0 for future use

Version 1.1 – Late May 2020

• Scripting Changes

  • Created an input manager to control custom inputs for the system

  • Custom interaction keys for choosing your own

  • Refactored and renamed code to be more consistent and optimised throughout

  • Changed variable names to make the scripts more consistent

  • Added an “Enum” for different types of UI displays when examining

• Miscellaneous

  • Added an additional UI example for displaying item text – Right hand side

  • Set canvas scaling to match screen resolution

  • Anchored all UI’s for correct functionality

Version 1.0 – Early May 2020

• Initial Release Code optimisations and improvements