Class: Bot

Bot()

Robot base class, useful for chatbots.

Constructor

new Bot()

Source:

Extends

Classes

Bot

Members

_isLoaded

Internal, set by WorldManager after the mesh/script has loaded.
Overrides:
Source:

active :boolean

Active i.e. online users
Type:
  • boolean
Overrides:
Source:

animation :string|null

Name of the animation that is currently active
Type:
  • string | null
Overrides:
Source:

className

Server-side class name
Overrides:
Source:

hasAvatar :boolean

true if the client has an avatar
Type:
  • boolean
Overrides:
Source:

humanoid :boolean

Does this client have humanoid avatar, default true
Type:
  • boolean
Overrides:
Source:

id :string

Id, equal on server and all instances
Type:
  • string
Overrides:
Source:

leftArmPos :Point

Left arm position
Type:
Overrides:
Source:

leftArmRot :Quaternion

Left arm rotation, quaternion
Type:
Overrides:
Source:

listeners

Event listeners. Typically world manager listens to changes, and moves objects around.
Overrides:
Source:

loadListeners

Load listeners, functions that trigger after the mesh or script is loaded. Managed by WorldManager. CHECKME SoC
Overrides:
Source:

mesh :string|null

URL of 3D mesh
Type:
  • string | null
Overrides:
Source:

name :string

Client name, must be unique
Type:
  • string
Overrides:
Source:

permanent :boolean

Default false, permanent objects remain in the scene forever
Type:
  • boolean
Overrides:
Source:

picture :string|null

avatar picture url
Type:
  • string | null
Overrides:
Source:

position :Point

Position, Point
Type:
Overrides:
Source:

properties :Object

Custom properties of an object - shared transient object
Type:
  • Object
Overrides:
Source:

rightArmPos :Point

Right arm position
Type:
Overrides:
Source:

rightArmRot :Quaternion

Right arm rotation, quaternion
Type:
Overrides:
Source:

rotation :Rotation|null

Rotation
Type:
Overrides:
Source:

scale :Point|null

Scale, Point
Type:
Overrides:
Source:

sceneProperties :SceneProperties

Scene properties
Type:
Overrides:
Source:

script :string|null

URL of dynamically loaded script
Type:
  • string | null
Overrides:
Source:

temporary :boolean

Everything created by guest client is by default temporary
Type:
  • boolean
Overrides:
Source:

tokens

Private tokens, map of strings
Overrides:
Source:

userHeight :number

User height, default 1.8
Type:
  • number
Overrides:
Source:

video :boolean

Does this client have video avatar, default false
Type:
  • boolean
Overrides:
Source:

VRSPACE

Handy reference to VRSpace instance
Overrides:
Source:

Methods

addListener()

Add a change listener to the object.
Overrides:
Source:

addLoadListener()

Add a load listener function to the object. Triggers immediatelly if mesh/script has already loaded (_isLoaded is true).
Overrides:
Source:

getID() → {ID}

Returns ID of this VRObject
Overrides:
Source:
Returns:
Type
ID

getNameOrId()

Handy function, returns name if not null, else class and id
Overrides:
Source:

notifyListeners()

Called when server sends notification that the object has changed. Notifies all listeners of object and changes.
Overrides:
Source:

notifyLoadListeners()

Triggers all load listeners
Overrides:
Source:

positionChanged()

Executedwhile handling network event. Empty implementation, overridden by EventRouter.
Overrides:
Source:

publish()

Publish the object to the server. Can be used only on new objects.
Overrides:
Source:

removeListener()

Remove the listener.
Overrides:
Source:

removeLoadListener()

Remove a load listener.
Overrides:
Source:

rotationChanged()

Executedwhile handling network event. Empty implementation, overridden by EventRouter.
Overrides:
Source:

scaleChanged()

Executedwhile handling network event. Empty implementation, overridden by EventRouter.
Overrides:
Source: