yawlighthouse / umg-slate-compendium Goto Github PK

A note from Nick Darnell; "The launcher has very little slate in it, mostly just the frame. It's primarily an embedded chromium app".
So I need to update the documentation to have that information so its more accurate in section 3.

• 4.9: Phrase a delegate fo has a typo, should be a delegate of

Here are the plans for the next major update to the compendium that are in progress.
When all of them are checked off then that means that this update is being verified(which means afterwards the document will be updated! For more information please refer to the FAQ).

• NEW Finally going to delve into TextBlock's and how they are setup.
• NEW Finally going to delve into Rich TextBlock's and how they are setup.

Since the contents of the textblock's and rich textblock's is a lot of material, I wanted to primarily focus on that for this update. If you have suggestions for smaller additional information to add, please comment on this ticket and I can review it and respond if its something that I can append ontu this update or if its something I'll have to get to in a future update. Please don't assume its already planned, I pick these subject's based off what the community requests, so request it! Even if its an obvious subject that's expected that I will eventually cover, I can't read minds and there is a lot to cover so I want to comb through based on priority that you suggest!

I made a discussion forum for new topics as well if you want to suggest a larger topic that wouldn't be covered in this update but still want it to be prioritized for the next one: LINK

Here are the plans for the next major update to the compendium that are in progress.
When all of them are checked off then that means that this update is being verified(which means afterwards the document will be updated! For more information please refer to the FAQ).

• Picture(s) Create Diagram showing how the game layer framework works with split screen's viewports
• Picture(s) Create visuals for explaining what each input mode and mouse lock modes does when changed in the game viewport client
  • Input Mode's
    • Input Mode UI Only
    • Input Mode Game Only
    • Input Mode Game & UI
  • Mouse Lock Modes
    • Do Not Lock
    • Lock On Capture
    • Lock Always
    • Lock in Fullscreen
• Picture(s) Create visual diagram for explaining Input Component's order of operations
• NEW Explanation about input modes persisting between level's
• NEW Explanation for Widget Components
  • Explanation for Widget Render Targets
• Picture(s) Explaining inheritance regarding UMG and User Widgets with visuals
• NEW Explanation for TSlateAttribute/TSlateManagedAttribute/TAttribute
• NEW Splitting the links section into its own page in the repository to help organize chunks of information that will continue to grow based on the community.

Need to add to helpful links section:

• https://github.com/sinbad/StevesUEHelpers
• https://github.com/sinbad/StevesUEExamples

How about supporting Continuous Localization in a project via GitLicalize, for example? Personally, I would like to translate the Compendium into Russian and update the translation as the original changes. And someone will probably want to translate it into other languages supported in the engine.

"SMyCoolWidget (no closing quote)

Slate (internally in the engine at least) works a lot with the SharedPtr/Ref system, so I think you should add something about this to the GC Slate section.

With that in mind, a little about StaticCastSharedPtr and Ref would be great too!

Here are the plans for the next major update to the compendium that are in progress.
When all of them are checked off then that means that this update is being verified(which means afterwards the document will be updated! For more information please refer to the FAQ).

• - Improved explanation in the introduction section to let people know about the FAQ
• - Explanation for HUD Actor
• - Explanation for how Shared Ptr's and Garbage Collection Work with Slate
• - Explanation for widget tick and when it happens.
• - Navigation Grid Explanation: Example of using focus delegates
• - Input Framework(in relation to UMG/Slate): Add new section for Input Components
• - Common Widgets: Add pictures for each widget
• - Common Widget Functionality: Add pictures for each value

Here are the plans for the next major update to the compendium that are in progress.
When all of them are checked off then that means that this update is being verified(which means afterwards the document will be updated! For more information please refer to the FAQ).

• Add explanation on finding gamepad ID for each local player, this is in ULocalPlayer where ControllerID is referring to Gamepad ID(its a naming convention issue that makes it difficult to understand)
• Add explanation of Slate Console Debugger
• Add explanation of Remotely debugging Slate on console/mobile
• Add explanation of Widget Reflector
• Performance & Design Considerations: Add improved descriptions of areas in UMG/Slate that can slow down performance due to incorrect understanding of how to use the system.
  • Performance regarding animations.
  • Performance regarding many widget components and various workarounds for this.
• User Widget Animation: Add picture of UMG designer with animations
• User Widget Events: Add pictures for each event

As a heads up, this update may take longer due to me moving to a new home soon(will update this ticket post move).
Update Finished moving, updates should continue at the usual cadence.

GitHub light theme isn't showing some images properly but in other themes they show up just fine.