OverlayWindow

Description

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

Constructor
new OverlayWindow( propertiesopt )

Parameters

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

Properties

Name Type Summary
position Vec2
size Vec2
visible boolean

Methods

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

Signals

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

Type Definitions

Properties
Type: object

 

Properties

Name Type Summary
title string
source string
width number
height number
visible boolean

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) 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( x, y )

Parameters

Name Type Description
x number
y number
(static) setPosition( position )

Parameters

Name Type Description
position Vec2
(static) setSize( width, height )

Parameters

Name Type Description
width number
height number
(static) setSize( size )

Parameters

Name Type Description
size Vec2
(static) setTitle( title )

Parameters

Name Type Description
title 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

visibleChanged( )
Returns: Signal

webEventReceived( message )
Returns: Signal

Parameters

Name Type Description
message object