UHummingbirdWidget Class Reference

#include <HummingbirdWidget.h>

Inherits UWidget.

Public Member Functions
void	SetSoundAttenuation (const FSoundAttenuationSettings &Settings)
	UPROPERTY (BlueprintAssignable) FHBBindingsReleasedSignature BindingsReleased
bool	IsReadyToCreateView () const
bool	IsReadyForBindings () const
bool	HasRequestedView () const
void	ShowPaintRects (bool show)
void	Load (const FString &path)
void	Reload ()
UTextureRenderTarget2D *	GetRenderTexture () const
UHummingbirdJSEvent *	CreateJSEvent ()
void	TriggerJSEvent (const FString &name, UHummingbirdJSEvent *eventData) const

Public Attributes
AActor *	Owner
FHBReadyForBindingsSignature	ReadyForBindings
FHBScriptingReady	HBScriptingReady
bool	bEnableComplexCSSSupport
bool	bReceiveInput
bool	bGammaCorrectedMaterial
FString	URL

Detailed Description

A HTML5 control powered by Hummingbird.

Member Function Documentation

CreateJSEvent()

UHummingbirdJSEvent* UHummingbirdWidget::CreateJSEvent

(

)

Creates an event that will be executed in JavaScript

GetRenderTexture()

UTextureRenderTarget2D* UHummingbirdWidget::GetRenderTexture

(

)

const

Gives access to the UI Texture

HasRequestedView()

bool UHummingbirdWidget::HasRequestedView

(

)

const

Tells if a View has been scheduled for creation

IsReadyForBindings()

bool UHummingbirdWidget::IsReadyForBindings

(

)

const

Tells if the View is ready to be created

IsReadyToCreateView()

bool UHummingbirdWidget::IsReadyToCreateView

(

)

const

Tells if the View is ready to be created

Load()

void UHummingbirdWidget::Load

(

const FString &

path

)

Requests a new URL to be loaded in the View

Reload()

void UHummingbirdWidget::Reload

(

)

Requests the View to reload the current URL

SetSoundAttenuation()

void UHummingbirdWidget::SetSoundAttenuation

(

const FSoundAttenuationSettings &

Settings

)

Sets the AttenuationSettings for the Sound Components Note: Sound is 2D by default. It can be changed to 3D if appropriate AttenuationSettings is set. for more details look at Unreal's documentation for AttenuationSettings

ShowPaintRects()

void UHummingbirdWidget::ShowPaintRects

(

bool

show

)

Tells the view to show/hide debug paint rectangles

TriggerJSEvent()

void UHummingbirdWidget::TriggerJSEvent	(	const FString &	name,
		UHummingbirdJSEvent *	eventData
	)		const

Triggers an event in JavaScript

UPROPERTY()

UHummingbirdWidget::UPROPERTY

(

BlueprintAssignable

)

When fired, the View has released its bindings.

Member Data Documentation

bEnableComplexCSSSupport

bool UHummingbirdWidget::bEnableComplexCSSSupport

Whether to enable support for complex CSS selectors (e.g. div > p, div ~ p)

bGammaCorrectedMaterial

bool UHummingbirdWidget::bGammaCorrectedMaterial

Whether this widget's material should be gamma corrected or not. Set to true if the widget is used for HUD. Set to false if it is used for in-game surface.

bReceiveInput

bool UHummingbirdWidget::bReceiveInput

Indicates whether input is forwarded to this view

HBScriptingReady

FHBScriptingReady UHummingbirdWidget::HBScriptingReady

Called when the View is ready to accept events

Owner

AActor* UHummingbirdWidget::Owner

Gets or sets the Actor containing any LiveViewComponents.

ReadyForBindings

FHBReadyForBindingsSignature UHummingbirdWidget::ReadyForBindings

When fired, the View is ready for binding events. Any event bound prior to this will be ignored

URL

FString UHummingbirdWidget::URL

The URL to load when the View is created