<aside> <img src="/icons/reorder_gray.svg" alt="/icons/reorder_gray.svg" width="40px" />

Menu

</aside>

Frostbyte’s Unreal Documentation

Intro

FAQ

Getting Started

Blueprint Principals

Blueprint Conventions

Folder Structure

Core Blueprints

Base Player Controller

Base HUD and GUI

Established systems

Doors

Debugging Tools

Better Print String

Links

References

Misc

Base template page

<aside> 💡

Naming conventions and encapsulation theory are stated here.

</aside>

Follow the official Unreal Engine Style Guide for an in-depth guide on naming conventions.

Variable prefixes

This will differ based off their protection level and other factors.

<aside> ❗

Always make variables private when possible! If variables are needed elsewhere, the following section will explain a solution.

</aside>

Getters

Create getters when private variables must be accessed by external classes or children.

• A getter is a pure and const function that returns a value(s)
• A getter is typically public
• A getter always has a prefix of “Get”

<aside> 💡

Getters are also useful for returning repetitive information, not just one variable.

• Ex. GetHasStatReachedZero returns stat ≤ 0
• Your code is now easier to read and very scalable
• These are known as helper functions

</aside>

Setters

Create setters when private variables must be modified with additional safeguarding

• A setter is a function that does additional work to set a variable
• A setter is typically private
  • This is because setters preserve encapsulation and enforce controlled state changes
• A setter always has a prefix of “Set”

<aside> 💡

Setters handle repetitive code before setting a variable.

• Ex. SetStat handles clamping an input and then sets your variable
• Just like getters, this is more readable and reusable

</aside>

Continue to Folder Structure