OverlayWebWindow

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts

Properties

Name	Type	Summary
url	string	Read-only.
position	Vec2
size	Vec2
visible	boolean

Constructor

new OverlayWebWindow( propertiesopt )

Parameters

Name	Type	Attributes	Default Value	Description
`properties`	OverlayWindow.Properties	<optional>	null

Methods

Name	Return Value	Summary
`clearDebugWindow`	None
`close`	None
`emitScriptEvent`	None
`emitWebEvent`	None
`getEventBridge`	object
`getPosition`	Vec2
`getSize`	Vec2
`getURL`	string
`initQml`	None
`isVisible`	boolean
`raise`	None
`sendToQml`	None
`setPosition`	None
`setPosition`	None
`setScriptURL`	None
`setSize`	None
`setSize`	None
`setTitle`	None
`setURL`	None
`setVisible`	None

Signals

Name	Summary
`closed`
`fromQml`
`hasClosed`
`hasMoved`
`moved`
`positionChanged`
`qmlToScript`
`resized`
`scriptEventReceived`
`sizeChanged`
`urlChanged`
`visibleChanged`
`webEventReceived`

Method Details

(static) clearDebugWindow( )

(static) close( )

(static) emitScriptEvent( message )

Parameters

Name	Type	Description
`message`	object

(static) emitWebEvent( message )

Parameters

Name	Type	Description
`message`	object

(static) getEventBridge( ) → {object} Returns: object

(static) getPosition( ) → {Vec2} Returns: Vec2

(static) getSize( ) → {Vec2} Returns: Vec2

(static) getURL( ) → {string} Returns: string

(static) initQml( properties )

Parameters

Name	Type	Description
`properties`	OverlayWindow.Properties

(static) isVisible( ) → {boolean} Returns: boolean

(static) raise( )

(static) sendToQml( message )

Parameters

Name	Type	Description
`message`	object

(static) setPosition( position )

Parameters

Name	Type	Description
`position`	Vec2

(static) setPosition( x, y )

Parameters

Name	Type	Description
`x`	number
`y`	number

(static) setScriptURL( script )

Parameters

Name	Type	Description
`script`	string

(static) setSize( size )

Parameters

Name	Type	Description
`size`	Vec2

(static) setSize( width, height )

Parameters

Name	Type	Description
`width`	number
`height`	number

(static) setTitle( title )

Parameters

Name	Type	Description
`title`	string

(static) setURL( url )

Parameters

Name	Type	Description
`url`	string

(static) setVisible( visible )

Parameters

Name	Type	Description
`visible`	boolean

Signal Details

closed( ) Returns: Signal

fromQml( message )
Returns: Signal

Parameters

Name	Type	Description
`message`	object

hasClosed( ) Returns: Signal

hasMoved( position )
Returns: Signal

Parameters

Name	Type	Description
`position`	Vec2

moved( position )
Returns: Signal

Parameters

Name	Type	Description
`position`	Vec2

positionChanged( ) Returns: Signal

qmlToScript( message )
Returns: Signal

Parameters

Name	Type	Description
`message`	object

resized( size )
Returns: Signal

Parameters

Name	Type	Description
`size`	Size

scriptEventReceived( message )
Returns: Signal

Parameters

Name	Type	Description
`message`	object

sizeChanged( ) Returns: Signal

urlChanged( ) Returns: Signal

visibleChanged( ) Returns: Signal

webEventReceived( message )
Returns: Signal

Parameters

Name	Type	Description
`message`	object