First Person Exploration Kit: Release Notes for version 2.0 and above

Release Notes for v2.2.7

• Fixed: Mouse look jitter, which was especially noticeable with VSync disabled
• Fixed: Camera zoom is now smoothed by delta time
• Changed: Increased object examination default rotation speed (from 150 to 300)
• Changed: Minor code cleanup in FPEFirstPersonController and FPEMouseLook
• Changed: Removed high runner calls gameObject.GetComponent(), repalced with single stored instance where appropriate
• Changed: Removed legacy FlipGamepadYAxis variable from FPEInputManager
• Added: Separate Y-Axis flip toggles for Gamepad and Mouse
• Added: FPEGameMenu prefab now has toggle buttons for both of the new Y-Axis flip options
• Added: New Y-Axis flip options are now saved as part of game option data
• Added: New Inspector value for Camera Zoom change rate
• Added: A new 'Delete Local Save Data' tool to the While Fun Games editor tools menu

Release Notes for v2.2.6

• Fixed: Updated behaviour which allows keys to be consumed from inventory/hand when a door is unlocked
• Fixed: Missing demo object put back location in demoScene_1
• Fixed: Stair mesh colliders now convex
• Changed: Minimum supported version to v2019.4.32f1
• Changed: Documentation updates (SRP guides and other)

Release Notes for v2.2.5

• Changed: Minimum supported version to v2018.4.35f1 per Unity LTS roadmap.

Release Notes for v2.2.4

• Fixed: If player start is rotated in x/z, player will be tilted off-axis
• Fixed: Some code comments with Interactables
• Fixed: Flipped Y axis incorrectly applied to mouse look
• Fixed: Documentation typos and broken links
• Fixed: FPEFindBrokenInteractions was using outdated PrefabUtility API
• Fixed: Player walk cycle variable has bad/broken timing in some
• Fixed: Custom put back strings not preserved in some cases when loading a game
• Fixed: When saving a game player sometimes falls. If loaded from same run of build, player does not fall. If quit game and start build a game and load via Continue, player falls. If quit to main menu and press Continue again, player does not fall
• Fixed: Player is initialized in some cases to think they were in the air
• Fixed: Player's initial height was sometimes set to crouch height
• Changed: Demo Main Menu scene now places player start at correct location, no longer prone to error
• Changed: Minor code formatting and organization changes
• Changed: All CS0618 compiler warnings now gone
• Changed: All CS0649 compiler warnings now gone
• Changed: demoDresser_A prefab updated so that the demoDuctTape in the left drawer uses actual duct tape prefab in accordance with new prefab workflow
• Changed: demoComplexDesk prefab updated so that demoToyBlock in right drawer uses actual toy block prefab in accordance with new prefab workflow
• Changed: Some script line endings were not Windows (CR LF)
• Added: New Documentation page about more effective use of Events with some interactable types
• Added: "Find Broken Interactions" menu tool now accounts for nested prefabs

Release Notes for v2.2.3

• Fixed: Typos in documentation
• Changed: Name of Game Collectible demo object modified for easier readability in game menu
• Changed: By default, reticle is now hidden when examining an object

Release Notes for v2.2.2

• Fixed: Inside demo level 1, the pink button on the left wall near radio's text read "this button was also created with any coding", now reads "...without any coding"
• Fixed: Turned off sprite packer in editor, as it sometimes caused lag when entering Play mode from the editor (especially on first Play of editor session)
• Changed: Moved DemoGenericButton.png texture out of the Models/SourceFiles directory so that the source files directory can be excluded/deleted without breaking any materials
• Changed: Modified FPEPlayerController.cs to reduce instances of motion stutter when performing certain player movements (such as circle strafing)
• Changed: Removed KitchenSinkTest.unity from Testing\Scenes as it was out of date and no longer required
• Changed: Removed empty demoScene_N folders as they were not being used
• Changed: Modified language in one type of Activation error message to indicate the error can be ignored in some specific cases
• Added: New links to Simplified Chinese and Japanese langauge documentation for FPE Kit Docs pages
• Added: Code comment inside FPE Inventory Manager to indicate how one can sort inventory items by title instead of chronological collection order, if desired

Release Notes for v2.2.1

• Fixed: Removed Unity 2018/2019 [ExecuteAlways] conditional attribute, as it was causing conflicts with v2018.X under 2018.3.1 and is not a hard requirement for gizmos to refresh well
• Changed: Minor documentation update to include notes about drawer physics tweaks
• Changed: FPEAttachedNote and FPEInventoryItemScript now use TextArea attribute to make editing long text strings in the Inspector a lot easier

Release Notes for v2.2: "Doors and Drawers" Update

• Fixed: demoToggleSwitch was missing initial interaction string and had slight lag when first turning on light.
• Fixed: In Game Menu, if you have almost two pages of one item (e.g. puzzle ball), then have the last item on page 2 be another item (e.g. apple), and drop the apple, an IndexOutOfRange exception occurred.
• Fixed: In Game Menu, if you had a stack of items (e.g. Battery), and 2 pages of items (e.g. puzzle ball), when you dropped/held the last battery from first page first slot, the first slot is blank and inventory is not re-ordered until the next time the menu was opened.
• Fixed: FPESaveLoadLogic error message typo
• Fixed: When scene zero does not contain an FPEMenu (e.g. someone deletes demoMainMenu and makes a build), the build causes player movement to break in scene zero because there is no menu. Introduced a script change that checks for this and prints an error if a build issue may arise.
• Fixed: Very rarely, mouse look sensitivity would drift down when game quick save and quick load happened.
• Fixed: Missing null assignment check against FPEHub on game start.
• Fixed: If player movement was frozen (e.g. in cutscene or menu), you could still hear footstep audio sometimes.
• Fixed: Some "player config" prefabs (for building custom player controller from scratch) had incorrect transform positions, making setup more tedious than it needed to be.
• Fixed: FPEMenu modified to support users who don't want to use FPECore object.
• Fixed: When saving and loading using quick save/load rapidly, player's restored look angle would change.
• Fixed: Custom "inventory get" sounds were ignored.
• Fixed: Demo Cabinet simplified. Will be deprecated for future versions, but existing version now works better.
• Fixed: Sometimes player would make "landing sound" when bumped by a moving object at low speed. "Minimum Fall Speed" variable added FPEFirstPersonController.cs to account for this.
• Changed: Added "repeat delay" to Activate interactions so that if you configure activation to EVERYTIME mode, it automatically disables the activation for some seconds before it can be activated again.
• Changed: Included documentation update to link to Add Ons repo (see https://github.com/whilefun/FPEAddons)
• Changed: Added Layer detection on start when running in editor to warn user if a required Layer is missing. This can occur if multiple assets are imported on top of FPEKit and overrite Layers. Also added this functionality to the While Fun Games, Tools menu
• Changed: Remove "RecalculateBounds" calls from interactable base script as this was no longer relevant to highlighting materials.
• Changed: Demo scenes are completely redesigned
• Changed: Swap out doors in level transition to be new types, not FPESimpleDoor type.
• Changed: Deprecate demoCabinetScript
• Changed: Door locks now work in two ways: Internal (e.g. key in door handle) and external (e.g. security system)
• Changed: doorLocked.ogg removed from Sounds folder, replaced with /Sounds/DoorsAndDrawers/doorLocked01.ogg and /Sounds/DoorsAndDrawers/doorLocked02.ogg
• Changed: All other door*.ogg sound files moved from Sounds/ to Sounds/DoorsAndDrawers
• Changed: FPEDoorSaveData class modified to included 3 new pieces of data: A custom vector3 for partial door open positions/rotations, a flag for internal lock and external lock states. See FPESaveDataTypes.cs for details.
• Changed: FPESimpleDoor, DemoSlidingDoorScript, and DemoCabinetScript will not be supported beyond v2.2 release. All future doors will be made using the FPEDoor types or one of the new derived door types
• Changed: Removed "UNITY_5 or newer" checks for setCursorVisibility() and setCursorTexture() in FPEInteractionManager since Unity 5.6.7f1 is now the minimum supported version
• Changed: Unity 2018 Physx no longer supports setting a CCD RigidBody to Kinematic. As a result, all Pickups and Inventory Items are assumed to have Continuous collision (which is probably a good idea anyway)
• Added: Add Doors (sliding, basic swinging always away from player, complex 'realistic' swinging), Drawers, and Doorbells
• Added: Various new sound effects for Doors and Drawer and related objects
• Added: Several new interactable demo objects (with related models, textures, etc.)
• Added: New warnings inside Activate type script to tell you if you forgot to assign an event in the Inspector, but try to activate them anyway.
• Added: DemoSecuritySystem for remotely locking and unlocking FPEDoor objects

Release Notes for v2.1

• Fixed: Documentation FAQ about breaking changes said "...It is best to make note off all changes...", but now says "...It is best to make note of all changes..."
• Fixed: If player was docked or was crouched when quitting to main menu, then started a new game, they were still Docked or crouched when the new game started
• Fixed: When player was in game with inventory items, audio diaries, or notes, chose to save, then returns to main menu, then decides to start a new game without exiting and re-entering the game, their inventory was not reset.
• Fixed: A few timing related items that were running independent of Time.deltaTime
• Fixed: Multi-page journals did not always get focus for xbox controller navigation. Navigation left and right was also not explicit
• Fixed: Inventory items that were flagged in a put back location could be put back but didn't display a string
• Fixed: Flag for "show Mouse Control Hints" in FPEInteractionManager was partially ignored, because unchecking it did not actually clear the mouse hints
• Fixed: Unity 2018 compiler directives added to Cursor functions to eliminate "Outdated API" warnings when opening in Unity 2018.x
• Fixed: When holding an inventory item and looking at another interaction (non-inventory), the interaction text hint said "Press R/XBoxY to put in Inventory", but that didn't actually work
• Fixed: When holding an inventory/pickup, looking at another pickup, then moving view away from the other pickup but into a putback, the currentInteractableObject doesn't get set to null. Result was that the secondary pickup remains assigned as the currentInteractable until pickup raycast hit is not longer true. To the player, it meant that the thing they were looking at was not reflected in the UI
• Fixed: Notification text (for Notes, for example) had bug where if nearly faded out, it would fade for next notification prematurely
• Changed FPEMenuButton now "clicks" using OnPointerUp() instead of InPointerDown(). This helps address "click to close UI" causing erroneous interaction events. For example, if clicking a button to close a UI using OnPointerDown(), that same down press can be carried through to FPEInteractionManager, causing the player to activate a button, pickup or drop an object, etc.
• Changed: Add cutscenes overview page to documentation
• Changed: System overview diagrams updated in documenation
• Changed: Update and added to UI/HUD section to mention new FPEHUD classes and prefabs
• Changed: Removed all UI components and code from FPEInteractionManagerScript. UI now lives in FPEHUD
• Changed: Legacy "Demo" HUD is still the default, but all visuals reside inside the FPEDefaultHUD script and prefab
• Changed: Added new UI sub-folder to Prefabs folder
• Changed: Moved the following UI prefabs into new Prefabs\UI\ sub-folder: FPEEventSystem, FPEGameMenu, FPEMainMenu, FPESimpleMenu, FPEMinimalHUD, and FPEDefaultHUD
• Changed: Moved player sound effects to Sounds\Player\Basic folder
• Changed: Moved player footstep soundbank into Sounds\SoundBanks\ folder
• Changed: Removed Audio and ScriptableObjects sub-folders from FPEPlayerController\FPECharacters\FPEFirstPerson\ as they were made empty by the above changes
• Changed: Replaced default player sound effects with improved ones. Defaults sound files are still present in Sounds\Player\Basic\
• Added: New Interaction Manager FSM with new FREE, IN_MENU, and SUSPENDED states to add support for Cutscenes
• Added: Demo Cutscenes (one cinematic that uses letterbox bars and automatic camera movement, and one simple UI-driven)
• Added: Cutscene helper scripts for using letterbox bars and forcing player look at transform during a cutscene
• Added: New soundbanks for jumping and landing for better variation
• Added: Delay to player landing sounds to prevent landing sound from playing immediately when level is loaded
• Added: New editor script to validate a given scene for all known save game errors (duplicate objects, missing prefabs, prefabs in wrong folder, etc.)
• Added: New documentaion to reflect new editor script, how to use, and how to fix any errors that are found
• Added: FPEHUD class and associated sub-classes as well as FPEHUDData class. FPEHUDData is populated by interaction manager, and consumed by FPEHUD

Release Notes for v2.0.2

• Fixed: Sometimes loaded game options such as look sensitivity did not get applied to input system until the options menu was first opened
• Fixed: Player can perform double jump by tapping jump button multiple times while in the air, causing second jump when player lands
• Fixed: When audio diary playback is in progress, and player exits the game back to the main menu, the diary keeps playing.
• Changed: Switching menu tabs in FPEGameMenu no longer triggers a call to SaveGameOptions(). Now only changes made to individual options trigger such a call.
• Fixed: Player movement was a bit loose, especially when stopping to perform small scale interactions. Input Gravity for "WASD" controls has been increased for Horizontal and Vertical inputs from 3 to 8. Lateral view bob movement was also reduced by 0.05 to aid in tightening up player control feel.
• Changed: Refreshed documentation, and added a new section detailing save game file locations and purpose.

Release Notes for v2.0.1

• Fixed: If player looks at an interactable, then backs away slowly, they are allowed player to exceed set interaction distance of said object.

Release Notes for v2.0

• Fixed: "Future" reticle assets was incorrectly Default not Sprite (2D/UI) so they didnt appear to be choices when changing GUI skin
• Fixed: Did efficiency pass on all UI elements to ensure no extraneous raycast targets, etc. are present
• Fixed: Fixed NullReferenceException if player presses the B button on XBox controller when there is no journal open. Related: Sometimes, erroneous "journal close" sound can be heard if player presses B button when no journal is visible.
• Fixed: Highlight in Unity 5 on some objects (especially those with cutout materials, etc.) can cause z-fighting.
• Fixed: Issue where two demoCabinets in your game caused both to activate whenever one was interacted with.
• Fixed: Slowed mouse movment when looking at an objec to interact with. When the player is strafing and also looking at an object, the slow mousespeed switching causes the mouse cursor and interaction text to stutter sometimes.
• Fixed: Player Controller now has more interesting/complete/standard customizations out of the box such as crouching, jumping, running, view bob, etc.
• Fixed: A few other small bugs and code refactor items
• Added: Added a new Input Management system to provide a layer of abstraction into controls for easier editing and addition of new control schemes (for arbitrary new hardware, controllers, etc.)
• Added: UnityEvent-based event support to allow users to specify arbitrary events through the Inspector. User can specify to repeat once, everytime, or toggle.
• Added: Proper inventory screen that will show Inventory and allow player to replay "discovered" audio diaries and read collected notes.
• Added: Ability for player to add applicable items to inventory after they've inspected them, or discard/put back as usual.
• Added: Custom 'Whilefun.FPEKit' namespace for all code to prevent name overlaps, compile conflicts, etc. when importing other packages, Standard Assets, etc.
• Added: Ability to force refresh on highlight materials such that activations that cause UV offset to change can ask for a material refresh if they know their materials are stale
• Added: Dock object that will engage the player in a fixed location and and limited mouse look space such that they can interact with an object while "at a station" for that object until such time as they are released from that object's interaction (example: sit at a radio or computer and fiddle with buttons while things happen, then get up after they have happened or user aborts interaction)
• Added: Demo objects to demonstrate all new/changed features
• Added: Snazzier documentation and new video clips showing the features/fixes.

• Fixed: initial examination does additional rotation to account for offset value in the inspector.
• Fixed: Sometimes, journal sound effect plays if close journal button is pressed, but no journal is open.
• Fixed: Bug where if you have more than 1 item in inventory, select item 2, close inventory, then re-open it the first AND second are highlighted depending on mouse positions
• Fixed: UI tabs on game menu need to have additional indicator (selected tab sprite?) in addition to mouse over highlight, as all 3 can be unhihglighted at times which makes it unclear what tab you are in)
• Fixed: When pickup two batteries in inventory, open menu, drop one, then drop other, only 1 is ever dropped.
• Fixed: Quanittiy stacked shown in UI is not updated once one battery is dropped.
• Fixed: Inventory 'Next page' movement on gamepad causes rapid fire infinite sounds when held down
• Fixed: XBOX navigation now works on all inventory screens
• Fixed: Issue when you pickup apple, put in inventory, open menu, drop. Error warning of cannot play disabled audio source.
• Fixed: When crouching is disabled, pressing crouch still causes 1 frame ish of crouching twitch
• Fixed: When using xbox controller, and pressing right bumper to change menu tabs, player jumps when menu is closed.
• Fixed: When adding all notes (~a dozen of them) to inventory, the 3rd page cannot be accessed. Button is enabled, but clicking it doesn't do anything.
• Fixed: When examining object when crouched, you stand up
• Fixed: UI display for save/load only comes up when operation is finished. Now uses coroutine so progress spinner keeps animating even when busy.
• Fixed: When loading a game, if were docked when saved, cannot undock. This requires saving 'currentDock' dock object, which might not work and may mean we can't save while docked.
• Fixed: Save game in level2 with 3 apples in inv. Load game from level 2, you have 4 apples. probably a stackable +1 error or something. Doesn't happen when there is just one, but happens if there are two or more.
• Fixed: When loading inventory that can be consumed, the consumer throws an error because audio source reference is stale.
• Fixed: Some activate types that are complex (such as state machines) now have save logic and data types where required. Old demo objects now save and load state as they should.
• Fixed: If player was running when the loaded the game, they will remain running until they press and release shift again
• Fixed: Cabinet toggle saved correctly
• Fixed: First interaction requires 2 clicks of left mouse button for some reason
• Fixed: demoToilet state was not saved/restored properly
• Fixed: demoSimpleDoor fires close event because of toggleOff being fired by default. Need to add a flag for this.
• Fixed: Journals save/load strings now correct
• Fixed: Audio Diary save/load strings now correct
• Fixed: If load game when audio diary is playing, it keeps playing (and showing text). Now stop diary when suspend player for load game, but keep playing for room transitions.
• Fixed: Passive Audio Diary hasBeenPlayed save/load was not working, can replay demoFlatPaper over and over, for example, adding redundant copies to the inventory each time
• Fixed: Control instructions image shows xbox B button opens menu, when in fact it does not. Need to add a Start button graphic and line item on xbox side to show menu open button
• Fixed: Options not loaded until first time game menu is opened
• Fixed: Unity2017: In interaction manager, change cursor line @ line 2481 to be '#if UNITY_5 || UNITY_2017' so it includes UNITY 2017
• Fixed: Removed shadow caster from purple box detector cylinder
• Fixed: Code inspection pass (old commented out stuff, spacing, function headers, commemts, etc.)
• Fixed: FPEInput no longer contains direct key and mouse button checks.
• Fixed: FPESimpleDoor player blocker blocks player when door is opening which feels annoying
• Fixed: Demo pickup rotate types read "look at X", now say "pick up x" instead
• Added: Make pickupRotationOffset on PIckup type actually do something :) Around line 637 of FPEInteractionManagerScript, position is set, rotation is set, but is not offset.
• Added: For custom namespace items, need to rename the class itself to be FPEFirstPersonController instead of FirstPersonController, as the import of StandardAssets stomps custom stuff completely.
• Added: custom UI elements for various Menus
• Added: Clean up the old Virtual Input stuff from Unity Standard Assets, as most of it is no longer required (see new FPEInputManager class)
• Added: Make check box on Audio Diary type so that it can optionally require audio diary to be "interacted with" to play back, or play as soon as discovered.
• Added: Add flag to audio diaries to auto play or require interaction
• Added: Create new designated position for "in inventory" for pickup types that can be held or dropped. Just like holding pickup now, but maybe inside the player capsule, or some designated zone. Then disable game objects.
• Added: Deterministic and fast sort order for inventory items
• Added: Highlighted tab graphic
• Added: Add flag to audio diaries to be "recallable" via the diary UI
• Added: Add 'system' menu for exit/resume game from 'inventory' screen
• Added: Method to add a note to the inventory.
• Added: Renamed StandardAssetBase
• Added: Add Audio Diary callback event to fire when audio diary is skipped or finished playing (e.g. so tape recorder can stop itself, stop animating, move a button up, or whatever)
• Added: Add 'got a new note' sound and small popup notification 'note added' so it's clear that notes are added during other regular interactions (static, pickup, etc.)
• Added: Remapped xbox buttons for Jump, Crouch, Run, and ensured no overlap
• Added: A custom minmax attribute, basic sound bank, etc. for making player steps and other sounds more varied and interesting.
• Added: Running (line 236 of FPEFirstPersonController, plus add toggles, etc.)
• Added: Control mapping image on the wall as well for the demo scene
• Added: Add toggle for look smoothing in the system menu
• Added: New Activate types to handle various types of activations, events, and repeat modes.
• Added: An 'FPEEventTrigger' type that provides an empty shell for UnityEvents and can arm or disarm other triggers when itself is triggered. Provided debug visualization checkbox.
• Added: A way to call event(s) on Dockable objects when Dock is finished and when Undock is finished (e.g. when docked into chair, turn on computer screen)
• Added: Merge old Activate type by incorporating Generic sub type. Keep Toggle sub type, and put ToggleOn event calls inside inherited activate so that inventory can still be required to ToggleON
• Added: Pickup and Put Down events to Pickup type, ensure they work and are implemented. This will eventually lead to full deprecation of "Play Secondary Audio" feature.
• Added: PutBack events
• Added: Ability to require specific inventory type and quantity for activations to work (keys in doors, batteries in machines, etc.)
• Added: Shifted the audio diary detection and playback and make it similar to notes, in taht if there is on attached, it just gets played and added to inventory. This makes more sense than standalone type.
• Added: For activatable items, add slot for required inventory item, quantity, and checkbox that requires it be held on interaction to "work" (e.g. hold battery, place in device), or just in inventory
• Added: Refresh reticle to be higher resolution (see old build @ 1080p, it looked bad)
• Added: Rebuild applicable previous demo objects with new interaction building blocks.
• Added: Re-factored menu button code and make toggle an extension of button (side effect was that mouse over toggle doesn't un-highlight buttons and vice-versa)
• Added: Saved Game/Load Game interfaces for inventory
• Added: A basic game saving and loading mechanism in FPESaveLoadManager class.
• Added: Cleaned up prefabs folder to ensure there aren't random ones that don't matter (looking at you, FPEUICamera)
• Added: Related to save data for inventory, clips for Audio Diaries now have to be located to the Resources folder so they can be reloaded at runtime.
• Added: Save Note and Audio Diary 'collected'/'played' states in level data
• Added: In FPESaveLoadLogic, added 'break;' on foundMatch to make things a little more efficient.
• Added: Generic Save Type.
• Added: Simple Door Save Type.
• Added: FPECore prefab to make "Getting Started" a lot easier, make scene transitions and hierarchy a lot cleaner.
• Added: Save/Load/Start toggle flags so they can optionally fire when these events happen.
• Added: Menu item in editor to perform automated testing to check for duplicate saveable object names, which may cause save/load conflicts.
• Added: Wall instructions in demoScen now show how to open the menu with XBox Start or escape button. Also post the instruction image on the wall.
• Added: An additional demo barebones template scene with nothing but required objects for interaction stuff (basically the output of the instructions, less any props)
• Added: Attached Note to a few demo objects, explaining how they work.
• Added: Demo objects to demonstrate all new/changed features
• Added: All error prints have function/class names that match actual function/class. Where possible, add helpful hints (e.g. during migration for Inventory Item prefabs)
• Added: Cleaned up Resources folder, along with right click context menu (that contained old WFG stuff)
• Added: Debug Keys (wrapped in flag and compiler directive) for SaveLoadManager and Menu(s)