LocationBookmarks

Description

The LocationBookmarks API provides facilities for working with location bookmarks. A location bookmark associates a name with a metaverse address.

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

Methods

Name Return Value Summary
addBookmark None Prompts the user to bookmark their current location. The user can specify the name of the bookmark in the dialog that is opened.
deleteBookmark None Prompts the user to delete a bookmark. The user can select the bookmark to delete in the dialog that is opened.
getAddress string Gets the metaverse address associated with a bookmark.
getHomeLocationAddress string Gets the metaverse address associated with the "Home" bookmark.
setHomeLocationToAddress None Sets the metaverse address associated with the "Home" bookmark.

Method Details

(static) addBookmark( )

Prompts the user to bookmark their current location. The user can specify the name of the bookmark in the dialog that is opened.

(static) deleteBookmark( )

Prompts the user to delete a bookmark. The user can select the bookmark to delete in the dialog that is opened.

(static) getAddress( bookmarkName ) → {string}
Returns: The metaverse address for the bookmark. If the bookmark does not exist, "" is returned.

Gets the metaverse address associated with a bookmark.

Parameters

Name Type Description
bookmarkName string Name of the bookmark to get the metaverse address for (case sensitive).
Example

Report the "Home" bookmark's metaverse address.

print("Home bookmark's address: " + LocationBookmarks.getAddress("Home"));
(static) getHomeLocationAddress( ) → {string}
Returns: The metaverse address for the "Home" bookmark.

Gets the metaverse address associated with the "Home" bookmark.

(static) setHomeLocationToAddress( address )

Sets the metaverse address associated with the "Home" bookmark.

Parameters

Name Type Description
address string The metaverse address to set the "Home" bookmark to.