Introduces the concept of "Active Ticking" to allow Slate to go to sleep when there is no need to update the UI.
While asleep, Slate will skip the Tick & Paint pass for that frame entirely.
- There are TWO ways to "wake" Slate and cause a Tick/Paint pass:
1. Provide some sort of input (mouse movement, clicks, and key presses). Slate will always tick when the user is active.
- Therefore, if the logic in a given widget's Tick is only relevant in response to user action, there is no need to register an active tick.
2. Register an Active Tick. Currently this is an all-or-nothing situation, so if a single active tick needs to execute, all of Slate will be ticked.
- The purpose of an Active Tick is to allow a widget to "drive" Slate and guarantee a Tick/Paint pass in the absence of any user action.
- Examples include animation, async operations that update periodically, progress updates, loading bars, etc.
- An empty active tick is registered for viewports when they are real-time, so game project widgets are unaffected by this change and should continue to work as before.
- An Active Tick is registered by creating an FWidgetActiveTickDelegate and passing it to SWidget::RegisterActiveTick()
- There are THREE ways to unregister an active tick:
1. Return EActiveTickReturnType::StopTicking from the active tick function
2. Pass the FActiveTickHandle returned by RegisterActiveTick() to SWidget::UnregisterActiveTick()
3. Destroy the widget responsible for the active tick
- Sleeping is currently disabled, can be enabled with Slate.AllowSlateToSleep cvar
- There is currently a little buffer time during which Slate continues to tick following any input. Long-term, this is planned to be removed.
- The duration of the buffer can be adjusted using Slate.SleepBufferPostInput cvar (defaults to 1.0f)
- The FCurveSequence API has been updated to work with the active tick system
- Playing a curve sequence now requires that you pass the widget being animated by the sequence
- The active tick will automatically be registered on behalf of the widget and unregister when the sequence is complete
- GetLerpLooping() has been removed. Instead, pass true as the second param to Play() to indicate that the animation will loop. This causes the active tick to be registered indefinitely until paused or jumped to the start/end.
[CL 2391669 by Dan Hertzka in Main branch]
Where dynamic event names were being constructed from tutorial assets, now reworked events to add a dynamic parameter.
UE-4978 - Restructure Tutorial Analytic Events
[CL 2377327 by Thomas Sarkanen in Main branch]
Tutorials now return a valid UWorld, enabling audio playback, timers and all sorts of good stuff.
Stage started event now fires on first stage.
Skipping a stage from BP now rebuilds content properly.
Added events for tutorial launch and close.
[CL 2330093 by Thomas Sarkanen in Main branch]
* Moved Slate.h into SlateBasics.h and began shifting less commonly used headers into SlateExtras.h.
* Slate.h now simply includes SlateBasics.h and SlateExtras.h.
* Slate.h includes a deprecated warning now to indicate that SlateBasics.h + specific includes should be used instead.
* Moved dozens of inlined functions using Slate widgets into .cpp files to avoid header dependencies.
* All code samples now include SlateBasics.h and SlateExtras.h so future shifts will not break most those projects, but not trigger the deprecation warning of including Slate.h.
#BUN
[CL 2329610 by Wes Hunt in Main branch]
Tweaked styles and layout to better suit a tab.
Also fixed browser not showing some tutorials if all assets are not yet loaded.
Progress is now updated periodically as the browser can be now open while a tutorial is in progress.
TTP# 347956 - TUTORIALS: Selecting More Tutorials can hide Tutorial Browser
[CL 2327011 by Thomas Sarkanen in Main branch]
Override parameter passed in to LaunchTutorial when the tutorial has been completed already.
TTP# 348110 - EDITOR: TUTORIALS: Completed tutorials should always restart when re-taken
[CL 2315684 by Thomas Sarkanen in Main branch]
Tutorials browser now always appears on the mainframe. This avoids the browser appearing on small torn-off windows if content is torn off while a tutorial is in progress.
Also fixed crash when opening a browser from a widget that used to be docked to anotehr tab (weak window pointer was invalid at this point).
TTP# 347014 - EDITOR: TUTORIAL: If a tab is undocked while being referenced in the "welcome to the unreal editor" tutorial, there will be two instances of the tutorial text
[CL 2305366 by Thomas Sarkanen in Main branch]
Make sure we have an overlay constructed for the window we just created for the asset.
TTP# 347174 - TUTORIAL: When clicking on a sub editor tutorial, the tutorial does not automatically popup if the sub editor is not already opened
[CL 2305305 by Thomas Sarkanen in Main branch]
Tutorial contexts for IOS/Android/Whatever are now hooked up (console setup ones are still missing).
Analytics added for tutorial usage in various places.
Added ability to reset tutorial state with -ResetTutorials command-line flag.
Cleaned up some unused code (still a lot more to come here!).
[CL 2302314 by Thomas Sarkanen in Main branch]
The tutorial system will then attach non-widget-bound content to the asset editor window.
Also, assets can now be opened from a tutorial blueprint.
[CL 2300747 by Thomas Sarkanen in Main branch]
TTP# 345094 - CRASH: Selecting the arrow keys in the tutorial will cause an immediate crash with the new Tutorial system
[CL 2293498 by Thomas Sarkanen in Main branch]
Icon is only visible if content is available for the editor in question.
Split editor settings into two groups - one is persistent settings and one is progress/state.
Tutorials record their dismissed state, so users can permenantly disable the 'nag' for a particular tutorial.
Tutorial content now solidifies when the mouse is hovered over it, so it can be made easier to read.
Fixed crash on startup if an intro tutorial was displaying rich text.
Also fixed crash for TTP# 345094, where a zero-length tutorial was being accessed.
[CL 2275934 by Thomas Sarkanen in Main branch]
Fixed visibility issues where hyperlinks could not be clicked.
Implemented BP functions for tutorial stage completion etc.
[CL 2264228 by Thomas Sarkanen in Main branch]
NOTE: Old tutorials not deprecated (yet), but widget highlights in old tutorials will stop working with this change!
Added new Blueprintable UEditorTutorial object.
Added suite of widgets and details customizations to display tutorials.
New system is available on command line switch -NewTutorials.
Slate changes:
Tag names are now stored in SWidgets, rather than simply being discarded.
Removed STutorialWrapper in favour of using Tags.
Added Tags to more multibox widgets, so virtually all can now be picked.
Added SWindow::HasOverlay so we dont attempt to add overlays to widows that cannot have them.
[CL 2244216 by Thomas Sarkanen in Main branch]