Selection Script Interface API
| Methods |
|---|
| Selection.addToSelectedItemsList(string listName, string itemType, QUuid id) |
| Selection.removeFromSelectedItemsList(string listName, string itemType, QUuid id) |
| Selection.removeListFromMap(string listName) |
| Selection.printList(string listName) |
| Signals |
|---|
| Selection.selectedItemsListChanged(string listName) |
The Selection Scripting Interface is a simple JavaScript API useful for grouping together Gameplay Objects like Avatars, Entities, or Overlays. The group is labelled with a name, like mySelection01, which can then be retrieved later through the Interface.
Contents
addToSelectedItems()
addToSelectedItems() adds the id associated with an item to the list called listName. Specify the type as a string with itemType, which can be "avatar", "entity", or "overlay".
Function
addToSelectedItemsList(string listName, string itemType, QUuid id)
Arguments
listName: string The list of items to which an item is being added.
itemType: string Specify the type of item as "avatar", "entity", or "overlay".
id: QUuid This is the id of the item being added.
Returns
bool: Returns true if the id was added to the list; false otherwise.
removeFromSelectedItemsList
Removes the id associated with an item from the list called listName. Specify the type as a string with itemType, which can be "avatar", "entity", or "overlay".
Function
removeFromSelectedItemsList(string listName, string itemType, QUuid id)
Arguments
- listName: string The list of items from which an item is being removed.
- itemType: string Specify the type of item as "avatar", "entity", or "overlay".
- id: QUuid This is the id of the item being removed.
Returns
bool: Returns true if the id was removed from the list; false otherwise. Will return false if the list doesn't contain any data.
removeListFromMap
Removes the list called listName from the internal QMap<QString, GameplayObjects>. Useful if you want to completely clear a list of objects and start over.
Function
removeListFromMap(string listName)
Arguments
- listName: string This is a list of items.
Returns
bool: Returns true if the list was removed from the map; false otherwise.
printList
Prints the list labelled with listName in the debug log (not the script log).
Function
printList(string listName)
Arguments
- listName: string This is a list of items.
Returns
void
selectedItemsListChanged
This signal is fired when an internal list in the QMap<QString, GameplayObjects> is changed (i.e. items are added to or removed from that list).
Function
selectedItemsListChanged(string listName)
Arguments
- listName: string This is a list of items.
Returns
void
Examples
<code>(function () {
print("Starting highlight script...............");
var _this = this;
var prevID = 0;
var listName = "contextOverlayHighlightList";
var listType = "entity";
_this.startNearGrab = function(entityID){
if (prevID !== entityID) {
Selection.addToSelectedItemsList(listName, listType, entityID);
prevID = entityID;
}
};
_this.releaseGrab = function(entityID){
if (prevID !== 0) {
Selection.removeFromSelectedItemsList("contextOverlayHighlightList", listType, prevID);
prevID = 0;
}
};
var cleanup = function(){
Entities.findEntities(MyAvatar.position, 1000).forEach(function(entity) {
try {
Selection.removeListFromMap(listName);
} catch (e) {
print("Error cleaning up.");
}
});
};
Script.scriptEnding.connect(cleanup);
});</code>
