ToolbarProxy - Vircadia API Docs

Description

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

An instance of a toolbar.

Retrieve an existing toolbar or create a new toolbar using Toolbars.getToolbar.

Methods

Name	Return Value	Summary
`addButton`	object	Currently doesn't work. Deprecated: This method is deprecated and will be removed.
`readProperties`	object	Gets the values of toolbar properties.
`readProperty`	object	Gets the value of a toolbar property.
`removeButton`	None	Currently doesn't work. Deprecated: This method is deprecated and will be removed.
`writeProperties`	None	Sets the values of toolbar properties. A property is added to the toolbar if a named property doesn't already exist.
`writeProperty`	None	Sets the value of a toolbar property. A property is added to the toolbar if the named property doesn't already exist.

Method Details

addButton( properties ) → {object}
Returns: The button added.

Currently doesn't work.

Deprecated: This method is deprecated and will be removed.

Parameters

Name	Type	Description
`properties`	object	Button properties

readProperties( propertyList ) → {object}
Returns: The names and values of the specified properties. If the toolbar doesn't have a particular property then the result doesn't include that property.

Gets the values of toolbar properties.

Parameters

Name	Type	Description
`propertyList`	Array.<string>	The names of the properties to get the values of. Toolbar properties are those in the QML implementation of the toolbar.

readProperty( propertyName ) → {object}
Returns: The value of the property if the property name is valid, otherwise undefined.

Gets the value of a toolbar property.

Parameters

Name	Type	Description
`propertyName`	string	The property name. Toolbar properties are those in the QML implementation of the toolbar.

removeButton( name )

Currently doesn't work.

Deprecated: This method is deprecated and will be removed.

Parameters

Name	Type	Description
`name`	string	Button name.

writeProperties( properties )

Sets the values of toolbar properties. A property is added to the toolbar if a named property doesn't already exist.

Parameters

Name	Type	Description
`properties`	object	The names and values of the properties to set. Toolbar properties are those in the QML implementation of the toolbar.

writeProperty( propertyValue )

Sets the value of a toolbar property. A property is added to the toolbar if the named property doesn't already exist.

Parameters

Name	Type	Description
`propertyValue`	object	The value of the property.