Navigation
API > API/Developer > API/Developer/ToolWidgets
Widget for displaying a user avatar icon. The avatar's background color is computed based on the Identifier. The avatar's displayed letter is the initial letter of the Description if it's alpha numeric, or a question mark otherwise.
| Name | SAvatar |
| Type | class |
| Header File | /Engine/Source/Developer/ToolWidgets/Public/SAvatar.h |
| Include Path | #include "SAvatar.h" |
Syntax
class SAvatar : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SAvatar
- FSlateControlledConstruction → SWidget → SCompoundWidget → SAvatar
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackgroundColor | FColor | The BackgroundColor used | SAvatar.h | |
| bShowInitial | bool | The setting that determines if we're showing the initial | SAvatar.h | |
| Description | FString | The Description of the avatar | SAvatar.h | |
| ForegroundColor | FColor | The ForegroundColor used (text) | SAvatar.h | |
| Identifier | FString | The Identifier of the avatar | SAvatar.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Construct this widget | SAvatar.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 OnPaint
(
const FPaintArgs& Args, |
The custom OnPaint handler necessary because we want to draw a circle | SAvatar.h |