Class AUxtPressableToggleButtonActor

A derived actor of AUxtPressableButtonActor with a UUxtToggleStateComponent component to track state and visuals for a button can which can be toggled on or off (checked or unchecked).

Inheritance

System::Object

AActor

AUxtBasePressableButtonActor

AUxtPressableButtonActor

AUxtPressableToggleButtonActor

Inherited Members

AUxtPressableButtonActor::AnimateFocus(float DeltaTime)

AUxtPressableButtonActor::AnimatePulse(float DeltaTime)

AUxtPressableButtonActor::AudioComponent

AUxtBasePressableButtonActor::AUxtBasePressableButtonActor()

AUxtPressableButtonActor::AUxtPressableButtonActor()

AUxtPressableButtonActor::BackPlateMeshComponent

AUxtPressableButtonActor::BackPlatePivotComponent

AUxtPressableButtonActor::bCanEditIconBrush

AUxtPressableButtonActor::BeginPulse(const UUxtPointerComponent *Pointer)

AUxtPressableButtonActor::bIsPlated

AUxtPressableButtonActor::ButtonBrush

AUxtBasePressableButtonActor::ButtonComponent

AUxtPressableButtonActor::ConstructIcon()

AUxtPressableButtonActor::ConstructLabel()

AUxtPressableButtonActor::CreateAndAttachComponent(FName Name, USceneComponent *Parent)

AUxtPressableButtonActor::FocusTimer

AUxtPressableButtonActor::FrontPlateCenterComponent

AUxtPressableButtonActor::FrontPlateMeshComponent

AUxtPressableButtonActor::FrontPlatePivotComponent

AUxtPressableButtonActor::GetButtonBrush()

AUxtBasePressableButtonActor::GetButtonComponent()

AUxtBasePressableButtonActor::GetFarTarget()

AUxtBasePressableButtonActor::GetFarTarget_Implementation()

AUxtPressableButtonActor::GetIconBrush()

AUxtPressableButtonActor::GetLabel()

AUxtPressableButtonActor::GetLabelTextBrush()

AUxtPressableButtonActor::GetMillimeterSize()

AUxtBasePressableButtonActor::GetPokeTarget()

AUxtBasePressableButtonActor::GetPokeTarget_Implementation()

AUxtPressableButtonActor::GetSize()

AUxtPressableButtonActor::IconComponent

AUxtPressableButtonActor::IsPlated()

AUxtPressableButtonActor::IsPulsing()

AUxtPressableButtonActor::Label

AUxtPressableButtonActor::LabelComponent

AUxtPressableButtonActor::LabelTextBrush

AUxtPressableButtonActor::MaterialIndex

AUxtPressableButtonActor::MillimeterSize

AUxtPressableButtonActor::OnBeginFocus(UUxtPressableButtonComponent *Button, UUxtPointerComponent *Pointer, bool WasAlreadyFocused)

AUxtPressableButtonActor::OnButtonDisabled(UUxtPressableButtonComponent *Button)

AUxtPressableButtonActor::OnButtonEnabled(UUxtPressableButtonComponent *Button)

AUxtPressableButtonActor::PrePulseMaterial

AUxtPressableButtonActor::PulseFadeTimer

AUxtPressableButtonActor::PulseMaterialInstance

AUxtPressableButtonActor::PulseTimer

AUxtPressableButtonActor::SetButtonBrush(const FUxtButtonBrush &Brush)

AUxtPressableButtonActor::SetIconBrush(const FUxtIconBrush &Brush)

AUxtPressableButtonActor::SetIsPlated(bool IsPlated)

AUxtPressableButtonActor::SetLabel(const FText &NewLabel)

AUxtPressableButtonActor::SetLabelTextBrush(const FUxtTextBrush &Brush)

AUxtPressableButtonActor::SetMillimeterSize(FVector Size)

AUxtPressableButtonActor::SetSize(FVector Size)

AUxtPressableButtonActor::Tick(float DeltaTime)

AUxtPressableButtonActor::UPROPERTY(EditAnywhere, Category="Uxt Pressable Button", BlueprintGetter="GetIconBrush", BlueprintSetter="SetIconBrush", meta=(EditCondition="bCanEditIconBrush"))

Namespace:

Assembly: .dll

Syntax

public: class AUxtPressableToggleButtonActor : public xtPressableButtonActor

Constructors

| Improve this Doc View Source

AUxtPressableToggleButtonActor()

Declaration

public: AUxtPressableToggleButtonActor()

| Improve this Doc View Source

UPROPERTY(EditAnywhere, Category="Uxt Pressable Button", BlueprintGetter="IsInitiallyChecked", BlueprintSetter="SetIsInitiallyChecked")

Should the button be toggled on or off at BeginPlay?

Declaration

protected: UPROPERTY(EditAnywhere, Category="Uxt Pressable Button", BlueprintGetter="IsInitiallyChecked", BlueprintSetter="SetIsInitiallyChecked") bool bIsInitiallyChecked

Parameters

Type	Name	Description
EditAnywhere	_a_uxt_pressable_toggle_button_actor_UPROPERTY_EditAnywhere_Category_BlueprintGetter_BlueprintSetter_
Category	_a_uxt_pressable_toggle_button_actor_UPROPERTY_EditAnywhere_Category_BlueprintGetter_BlueprintSetter_
BlueprintGetter	_a_uxt_pressable_toggle_button_actor_UPROPERTY_EditAnywhere_Category_BlueprintGetter_BlueprintSetter_
BlueprintSetter	_a_uxt_pressable_toggle_button_actor_UPROPERTY_EditAnywhere_Category_BlueprintGetter_BlueprintSetter_

Fields

| Improve this Doc View Source

bToggleOnRelease

Should the button toggle on press or release?

Declaration

protected: bool bToggleOnRelease= false

Field Value

Type	Description
bool

| Improve this Doc View Source

TogglePlateComponent

Visual component to indicate the toggled state.

Declaration

protected: UUxtBackPlateComponent * TogglePlateComponent= nullptr

Field Value

Type	Description
UUxtBackPlateComponent *

| Improve this Doc View Source

ToggleStateComponent

Component which keeps track of the toggled state.

Declaration

protected: UUxtToggleStateComponent * ToggleStateComponent= nullptr

Field Value

Type	Description
UUxtToggleStateComponent *

Methods

| Improve this Doc View Source

BeginPlay()

Subscribes to toggle events and sets the initial toggle state.

Declaration

public: virtual void BeginPlay() override

| Improve this Doc View Source

ConstructVisuals()

Adds toggle visuals and components.

Declaration

public: virtual void ConstructVisuals() override

Overrides

AUxtPressableButtonActor::ConstructVisuals()

| Improve this Doc View Source

IsInitiallyChecked()

Gets if the button was toggled on at BeginPlay.

Declaration

public: bool IsInitiallyChecked() const

Returns

Type	Description
bool

| Improve this Doc View Source

OnButtonPressed(UUxtPressableButtonComponent Button, UUxtPointerComponent Pointer)

Button pressed event delegate.

Declaration

protected: virtual void OnButtonPressed(UUxtPressableButtonComponent *Button, UUxtPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtPressableButtonComponent *	Button
UUxtPointerComponent *	Pointer

Overrides

AUxtPressableButtonActor::OnButtonPressed(UUxtPressableButtonComponent *Button, UUxtPointerComponent *Pointer)

| Improve this Doc View Source

OnButtonReleased(UUxtPressableButtonComponent Button, UUxtPointerComponent Pointer)

Button released event delegate.

Declaration

protected: virtual void OnButtonReleased(UUxtPressableButtonComponent *Button, UUxtPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtPressableButtonComponent *	Button
UUxtPointerComponent *	Pointer

Overrides

AUxtPressableButtonActor::OnButtonReleased(UUxtPressableButtonComponent *Button, UUxtPointerComponent *Pointer)

| Improve this Doc View Source

OnButtonToggled(UUxtToggleStateComponent *ToggleState)

Updates the toggle visuals when the toggles state changes.

Declaration

protected: virtual void OnButtonToggled(UUxtToggleStateComponent *ToggleState)

Parameters

Type	Name	Description
UUxtToggleStateComponent *	ToggleState

| Improve this Doc View Source

OnConstruction(const FTransform &Transform)

Ensures the toggle visuals get updated when constructed.

Declaration

public: virtual void OnConstruction(const FTransform &Transform) override

Parameters

Type	Name	Description
const FTransform &	Transform

Overrides

AUxtPressableButtonActor::OnConstruction(const FTransform &Transform)

| Improve this Doc View Source

RemoveTogglePlate()

Option to remove the toggle plate if it is not needed for this button (for example in derived classes).

Declaration

public: void RemoveTogglePlate()

| Improve this Doc View Source

SetIsInitiallyChecked(bool InitiallyChecked)

Sets if the button was toggled on at BeginPlay. This method has no function after BeginPlay.

Declaration

public: void SetIsInitiallyChecked(bool InitiallyChecked)

Parameters

Type	Name	Description
bool	InitiallyChecked

| Improve this Doc View Source

UpdateToggleVisuals()

Alters the toggle visuals when the toggle state changes.

Declaration

public: virtual void UpdateToggleVisuals()