OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | Events | List of all members
OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject Interface Reference
Inheritance diagram for OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject:
Collaboration graph
[legend]

Public Member Functions

void Say (string msg)
 Causes the object to speak to its surroundings, equivilent to LSL/OSSL llSay More...
 
void Say (string msg, int channel)
 Causes the object to speak to on a specific channel, equivilent to LSL/OSSL llSay More...
 
void Dialog (UUID avatar, string message, string[] buttons, int chat_channel)
 Opens a Dialog Panel in the Users Viewer, equivilent to LSL/OSSL llDialog More...
 

Properties

bool Exists [get]
 Returns whether or not this object is still in the world. Eg, if you store an IObject reference, however the object is deleted before you use it, it will throw a NullReference exception. 'Exists' allows you to check the object is still in play before utilizing it. More...
 
uint LocalID [get]
 The local region-unique ID for this object. More...
 
String Description [get, set]
 The description assigned to this object. More...
 
UUID OwnerId [get]
 Returns the UUID of the Owner of the Object. More...
 
UUID CreatorId [get]
 Returns the UUID of the Creator of the Object. More...
 
IObject Root [get]
 Returns the root object of a linkset. If this object is the root, it will return itself. More...
 
IObject[] Children [get]
 Returns a collection of objects which are linked to the current object. Does not include the root object. More...
 
IObjectMaterial[] Materials [get]
 Returns a list of materials attached to this object. Each may contain unique texture and other visual information. For primitive based objects, this correlates with Object Faces. For mesh based objects, this correlates with Materials. More...
 
Vector3 Scale [get, set]
 The bounding box of the object. Primitive and Mesh objects alike are scaled to fit within these bounds. More...
 
Quaternion WorldRotation [get, set]
 The rotation of the object relative to the Scene More...
 
Quaternion OffsetRotation [get, set]
 The rotation of the object relative to a parent object If root, works the same as WorldRotation More...
 
Vector3 OffsetPosition [get, set]
 The position of the object relative to a parent object If root, works the same as WorldPosition More...
 
Vector3 SitTarget [get, set]
 
String SitTargetText [get, set]
 
String TouchText [get, set]
 
String Text [get, set]
 Text to be associated with this object, in the Second Life(r) viewer, this is shown above the object. More...
 
bool IsRotationLockedX [get, set]
 
bool IsRotationLockedY [get, set]
 
bool IsRotationLockedZ [get, set]
 
bool IsSandboxed [get, set]
 
bool IsImmotile [get, set]
 
bool IsAlwaysReturned [get, set]
 
bool IsTemporary [get, set]
 
bool IsFlexible [get, set]
 
IObjectShape Shape [get]
 
PhysicsMaterial PhysicsMaterial [get, set]
 
IObjectPhysics Physics [get]
 
IObjectSound Sound [get]
 
IObjectInventory Inventory [get]
 
- Properties inherited from OpenSim.Region.OptionalModules.Scripting.Minimodule.IEntity
string Name [get, set]
 
UUID GlobalID [get]
 
Vector3 WorldPosition [get, set]
 

Events

OnTouchDelegate OnTouch
 

Detailed Description

Definition at line 52 of file IObject.cs.

Member Function Documentation

void OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Dialog ( UUID  avatar,
string  message,
string[]  buttons,
int  chat_channel 
)

Opens a Dialog Panel in the Users Viewer, equivilent to LSL/OSSL llDialog

Parameters
avatarThe UUID of the Avatar to which the Dialog should be send
messageThe Message to display at the top of the Dialog
buttonsThe Strings that act as label/value of the Bottons in the Dialog
chat_channelThe channel on which to send the response

Implemented in OpenSim.Region.OptionalModules.Scripting.Minimodule.SOPObject.

void OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Say ( string  msg)

Causes the object to speak to its surroundings, equivilent to LSL/OSSL llSay

Parameters
msgThe message to send to the user

Implemented in OpenSim.Region.OptionalModules.Scripting.Minimodule.SOPObject.

void OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Say ( string  msg,
int  channel 
)

Causes the object to speak to on a specific channel, equivilent to LSL/OSSL llSay

Parameters
msgThe message to send to the user
channelThe channel on which to send the message

Implemented in OpenSim.Region.OptionalModules.Scripting.Minimodule.SOPObject.

Property Documentation

IObject [] OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Children
get

Returns a collection of objects which are linked to the current object. Does not include the root object.

Definition at line 118 of file IObject.cs.

UUID OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.CreatorId
get

Returns the UUID of the Creator of the Object.

Definition at line 108 of file IObject.cs.

String OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Description
getset

The description assigned to this object.

Definition at line 98 of file IObject.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Exists
get

Returns whether or not this object is still in the world. Eg, if you store an IObject reference, however the object is deleted before you use it, it will throw a NullReference exception. 'Exists' allows you to check the object is still in play before utilizing it.

IObject deleteMe = World.Objects[0];

if (deleteMe.Exists) { deleteMe.Say("Hello, I still exist!"); }

World.Objects.Remove(deleteMe);

if (!deleteMe.Exists) { Host.Console.Info("I was deleted"); }

Objects should be near-guarunteed to exist for any event which passes them as an argument. Storing an object for a longer period of time however will limit their reliability.

It is a good practice to use Try/Catch blocks handling for NullReferenceException, when accessing remote objects.

Definition at line 88 of file IObject.cs.

IObjectInventory OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Inventory
get

Grants access to the objects inventory

Definition at line 214 of file IObject.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.IsAlwaysReturned
getset

Definition at line 166 of file IObject.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.IsFlexible
getset

Definition at line 169 of file IObject.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.IsImmotile
getset

Definition at line 165 of file IObject.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.IsRotationLockedX
getset

Definition at line 161 of file IObject.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.IsRotationLockedY
getset

Definition at line 162 of file IObject.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.IsRotationLockedZ
getset

Definition at line 163 of file IObject.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.IsSandboxed
getset

Definition at line 164 of file IObject.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.IsTemporary
getset

Definition at line 167 of file IObject.cs.

uint OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.LocalID
get

The local region-unique ID for this object.

Definition at line 93 of file IObject.cs.

IObjectMaterial [] OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Materials
get

Returns a list of materials attached to this object. Each may contain unique texture and other visual information. For primitive based objects, this correlates with Object Faces. For mesh based objects, this correlates with Materials.

Definition at line 125 of file IObject.cs.

Vector3 OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.OffsetPosition
getset

The position of the object relative to a parent object If root, works the same as WorldPosition

Definition at line 147 of file IObject.cs.

Quaternion OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.OffsetRotation
getset

The rotation of the object relative to a parent object If root, works the same as WorldRotation

Definition at line 141 of file IObject.cs.

UUID OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.OwnerId
get

Returns the UUID of the Owner of the Object.

Definition at line 103 of file IObject.cs.

IObjectPhysics OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Physics
get

Definition at line 182 of file IObject.cs.

PhysicsMaterial OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.PhysicsMaterial
getset

Definition at line 180 of file IObject.cs.

IObject OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Root
get

Returns the root object of a linkset. If this object is the root, it will return itself.

Definition at line 113 of file IObject.cs.

Vector3 OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Scale
getset

The bounding box of the object. Primitive and Mesh objects alike are scaled to fit within these bounds.

Definition at line 130 of file IObject.cs.

IObjectShape OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Shape
get

Definition at line 171 of file IObject.cs.

Vector3 OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.SitTarget
getset

Definition at line 149 of file IObject.cs.

String OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.SitTargetText
getset

Definition at line 150 of file IObject.cs.

IObjectSound OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Sound
get

Definition at line 184 of file IObject.cs.

String OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.Text
getset

Text to be associated with this object, in the Second Life(r) viewer, this is shown above the object.

Definition at line 159 of file IObject.cs.

String OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.TouchText
getset

Definition at line 152 of file IObject.cs.

Quaternion OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.WorldRotation
getset

The rotation of the object relative to the Scene

Definition at line 135 of file IObject.cs.

Event Documentation

OnTouchDelegate OpenSim.Region.OptionalModules.Scripting.Minimodule.IObject.OnTouch

Definition at line 56 of file IObject.cs.


The documentation for this interface was generated from the following file: