ARVirtualWorld

From Blue Mars Developer Guidebook

Jump to: navigation, search
There are security restrictions on this article

Contents

Overview

ARVirtualWorld table has methods for controlling the HUD and the avatar data in a virtual world (city) level.

Singleton

The ARVirtualWorld works as a singleton object. Always use the Instance member to access the singleton object.

Methods

ShowHUD - deprecated
ARVirtualWorld.Instance:ShowHUD ()

Original functionality: showed HUD avatar controller.


HideHUD - deprecated
ARVirtualWorld.Instance:HideHUD ()

Original functionality: hid HUD avatar controller.


Functions

GetAvatarData

ARVirtualWorld.GetAvatarData (entity)

Returns an avatar data table of the specified entity. The returned table contains the following keys:

ClientID
(number) The owner's client ID
Name
(string) The avatar's name
ShortName
(string) The avatar's short name (registered as "User ID" on user registration)
Items
(table) The attached items (i.e. clothes and accessories)
Face
(binary data) The avatar's face data
Gender
(string) The avatar's gender; "M" for male, "F" for female

Time of Day

These functions access the simulated time of day (vs. the real time of day in the System time functions)


GetTimeOfDay()
returns the current simulated time of day


SetTimeOfDay(time)
set the current simulated time of day


GetTimeOfDaySpeed()
returns the time of day speed


SetTimeOfDaySpeed(time)
set the time of day speed


GetTimeOfDayStart()
returns the time of day start hour


SetTimeOfDayStart(time)
set the time of day start hour


GetTimeOfDayEnd()
returns the time of day end hour


SetTimeOfDayEnd(time)
set the time of day end hour
Problems with this wiki page? Contact us either by: Support Email or Support Ticket System

Blue Mars Guidebook Privacy Policy
Blue Mars Guidebook Community Guidelines

Personal tools