The environment in which we're running.

Returns true if the local client has management privileges in the current room. A user with management permissions can edit the room, among other things. Passing 0 for the memberId indicates that this instance's viewing user should be checked. Note that this may change without notice, meaning that you shouldn't just check it once for a user and assume they still have management permissions later.

Clear any showing popup. May be called at any time.

Access the local user's camera.

Calling Camera.getCamera() does not work inside whirled due to security restrictions. For convenience, this method works even when you're not connected.

Get the default datapack for this entity, or null if there is none defined. The DataPack is returned as a ByteArray, which can easily be passed to the com.whirled.DataPack constructor. We do not return a DataPack for you, because otherwise including this class would include all the DataPack support classes, even if your project never made use of it.

Enumerates the ids of all entities in this room.

Looks up and returns the specified property for the specified entity. Returns null if the entity does not exist or the entity has no such property.

Get the "environment" in which this entity is presently running.

Get the id of the viewer that is viewing this instance. An instance is the copy of the entity running in a particular user's browser. If you are in a room with 2 other people, each piece of furniture has three instances: one on each person's browser.

Returns our current logical location in the scene. Note that if y is nonzero, you are flying. If applicable, an avatar should animate appropriately. The actor method isMoving() may return true or false when flying, depending on whether you're floating or actually moving between locations.

See also

Return an associative hash of all the memories. This is not a cheap operation. Use getMemory if you know what you want.

See also

Returns the value associated with the supplied key in this item's memory. If no value is mapped in the item's memory, the supplied default value will be returned.

Access the local user's microphone.

Calling Microphone.getMicrophone() does not work inside whirled due to security restrictions. For convenience, this method works even when you're not connected.

Get the id3 metadata of the currently playing music. This will be an Object roughly in the format of flash.media.Id3Info, except that only the "raw" names of id3 tags are supported. http://www.id3.org

Get the playerId of the owner of the currently playing music, aka the player who added it to the playlist, or 0 if there is no music currently playing.

Returns the Whirled-wide unique ID of this copy of the entity. Multiple copies of the same avatar in a room, for example, each have different entity IDs.

Returns our current location in the scene, in pixel coordinates.

Get the room's bounds in pixels.

Get the non-unique display name of the user viewing a particular instance. Note that this cannot be used to look up member names of people who are not in the room.

TODO: other examples of where the member id comes from.

Detects whether this client is in control.

Control is a mutually exclusive lock across all instances of the entity (i.e. running in other browsers across the network). Only one client can hold the lock at any time.

Register a function used for generating a custom config panel. This will be called when this piece of furniture is being edited inside whirled.

Registers a function that provides custom entity properties. This should be done immediately after creating your EntityControl, for example:

     var ctrl :FurniControl = new FurniControl(this);
     ctrl.registerPropertyProvider(getEntityProperty);
     

Send a message to other instances of this entity, resulting in a MESSAGE_RECEIVED event.

Note: the name must be a String and may be up to 64 characters. The argument may be up to 1024 bytes after being AMF3 encoded.

Note: Any instance can send messages. Compare with triggerAction.

Send a message to all instances of all entities in this instance's current room, resulting in a SIGNAL_RECEIVED event. All instances of the entity can initiate a signal, so the user must take care to check for control when appropriate.

Note: the name must be a String and may be up to 64 characters. The argument may be up to 1024 bytes after being AMF3 encoded.

Set the layout "hotspot" for your item, specified as pixels relative to (0, 0) the top-left coordinate. If unset, the default hotspot will be based off of the SWF dimensions, with x = width / 2, y = height.

Requests that this item's memory be updated with the supplied key/value pair. The supplied value must be a simple object (Integer, Number, String) or an Array of simple objects. The contents of the entity's memory (keys and values) must not exceed 4096 bytes when AMF3 encoded.

Setting the memory for a key to null clears that key; subsequent lookups will return the default value.

Note: for avatars, only the instance "in control" can update memories, but this restriction does not hold (presently) for pets, furni, toys, or backdrops. Put another way, only the instance of the person wearing the avatar can update memories.

Configures the interval on which this item is "ticked" in milliseconds. If the client setting this interval is in control, it will get a timer event at the specified interval.

Ticking mechanism is turned off by default. Application needs to set the interval explicitly to start receiving tick events. The tick interval can be no smaller than 100ms to avoid bogging down the client.

Show a popup to the current user in the whirled. Only one popup between all entities in a room can be show at one time. Calling this closes any existing popup currently open.

Triggers an action on this scene object. The action will be properly distributed to the object running in every client in the scene, resulting in a ACTION_TRIGGERED event.

Note: the name must be a String and may be up to 64 characters. The argument may be up to 1024 bytes after being AMF3 encoded.

Note: Only the instance "in control" can trigger actions. If you want any instance to be able to communicate, use sendMessage().

Dispatched when the instance in control sends a trigger action to all instances.

An event type dispatched when an action is triggered.
name - action name
value - action value

Dispatched to entities when they overhear chatter in the room. Only the instance in control receives this event.

An event type dispatched to all entities when someone chats. Note that only the instance in control receives this event.
name - the speaker's entity ID
value - chat message

Dispatched when this instance gains control. See the hasControl method.

An event type dispatched when this client-side instance of the item has gained "control" over the other client-side instances.
name - unused
value - unused

Dispatched when an entity enters the room.

An event dispatched when a new entity has been added to the room. Note: only the instance in control receives this event.
name - The new entity ID
value - unused

Dispatched when an entity leaves the room.

An event dispatched when an entity has been removed from the room. Note: only the instance in control receives this event.
name - The entity ID. Note that this will no longer exist in the room.
value - unused

Dispatched when an entity in the room (other than the listening entity) changes location.

An event dispatched when an actor begins and ends walking within the room. Note: only the instance in control receives this event.
name - The moving entity's ID
value - If the actor has started moving, this is an array containing the logical location it is moving to. Null when this event fires in response to the actor arriving at its destination.

Dispatched when the instance in control updates the memory of this digital item.

An event type dispatched when the memory has changed.
name - memory name
value - memory value

Dispatched when any instance sends a message to all instances.

An event type dispatched when a message is received.
name - message name
value - message value

Dispatched when id3 data is found in the currently playing song. Apparently many mp3 files contain both 2.id3 data, near the beginning of the file, and 1.data, found at the end, and so flash dispatches each set of data as it finds it. And we just pass it along to you.

An event that may be dispatched soon after music starts playing.
name - unused
value - an Object from which id3 tags may be read.

Dispatched when music starts playing in the room. If the current user can hear it, id3 data aybe available shortly after this event. The sequence of events goes like this: MUSIC_STARTED, 0 or more MUSIC_ID3 tags, MUSIC_STOPPED. Note however that you may not get a MUSIC_STARTED event if the music starts playing prior to your entity initializing. Calling getMusicOwnerId() can tell you definitively if there is music currently playing.

An event dispatched when some music starts playing.
name - unused
value - unused

Dispatched when music stops playing in the room.

An event dispatched when some music stops playing.
name - unused
value - unused

See also

Dispatched when any entity or AVR game sends a message to all other entities.

Note: this is only dispatched to the instance in control.

An event type dispatched when a signal is received. Dispatched only to the instance in control.
name - signal name
value - signal value

See also

Dispatched once per tick, only when this instance has control and only if tick interval is registered.

A constant returned by getEnvironment() to indicate that this entity is being viewed in a room. Memories are persistent.

A constant returned by getEnvironment() to indicate that this entity is being viewed in the shop. If the user buys the item, any memories will be saved for the user's new copy of the item.

A constant returned by getEnvironment() to indicate that this entity is being viewed in the "viewer": memories may be set and read, but they will not be saved.

The entity pixel dimensions (an Array [width, height]). Use with getEntityProperty().

The entity's hot spot (an Array [x, y]). Use with getEntityProperty().

The entity's location in logical coordinates (an Array [ x, y, z ]). x, y, and z are Numbers between that are typically between 0 and 1 or null if our location is unknown. Note that Whirled allows furniture to be positioned "outside" the room, at locations less than 0 or greater than 1, in order to create a desired effect, so don't be surprised if something is placed at wacky coordinates. Use with getEntityProperty().

The entity's location in pixel coordinates (an Array [ x, y, z ]). Obviously there is not a real Z coordinate, but the value will coorrespond to real Z distance in proportion to the distance in X and Y. Use with getEntityProperty().

The unique Whirled player ID (int) of the wearer of the avatar, or the owner of the pet. Use with getEntityProperty().

The current movement speed of an actor (Number).

The non-unique display name of the entity (a String). Use with getEntityProperty(). Valid only for "avatar" and "pet" entity types. Invalid entity types will return null.

The entity facing direction (a Number). Use with getEntityProperty(). Valid only for "avatar" and "pet" entity types.

The type of the entity, TYPE_AVATAR, TYPE_PET or TYPE_FURNI. Use with getEntityProperty().

The type of avatar entities.

The type of furniture entities.

The type of pet entities.