OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject Interface Reference
Public Member Functions | |
| void | Say (string msg) |
| Causes the object to speak to its surroundings, equivilent to LSL/OSSL llSay. | |
| void | Say (string msg, int channel) |
| Causes the object to speak to on a specific channel, equivilent to LSL/OSSL llSay. | |
| void | Dialog (UUID avatar, string message, string[] buttons, int chat_channel) |
| Opens a Dialog Panel in the Users Viewer, equivilent to LSL/OSSL llDialog. | |
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. | |
| uint | LocalID [get] |
| The local region-unique ID for this object. | |
| String | Description [get, set] |
| The description assigned to this object. | |
| UUID | OwnerId [get] |
| Returns the UUID of the Owner of the Object. | |
| UUID | CreatorId [get] |
| Returns the UUID of the Creator of the Object. | |
| IObject | Root [get] |
| Returns the root object of a linkset. If this object is the root, it will return itself. | |
| IObject[] | Children [get] |
| Returns a collection of objects which are linked to the current object. Does not include the root object. | |
| 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. | |
| Vector3 | Scale [get, set] |
| The bounding box of the object. Primitive and Mesh objects alike are scaled to fit within these bounds. | |
| Quaternion | WorldRotation [get, set] |
| The rotation of the object relative to the Scene. | |
| Quaternion | OffsetRotation [get, set] |
| The rotation of the object relative to a parent object If root, works the same as WorldRotation. | |
| Vector3 | OffsetPosition [get, set] |
| The position of the object relative to a parent object If root, works the same as WorldPosition. | |
| 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. | |
| 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] |
Events | |
| OnTouchDelegate | OnTouch |
Member Function Documentation
| void OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::Say | ( | string | msg | ) |
Causes the object to speak to its surroundings, equivilent to LSL/OSSL llSay.
- Parameters:
-
msg The 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:
-
msg The message to send to the user channel The channel on which to send the message
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
| 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:
-
avatar The UUID of the Avatar to which the Dialog should be send message The Message to display at the top of the Dialog buttons The Strings that act as label/value of the Bottons in the Dialog chat_channel The channel on which to send the response
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
Property Documentation
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.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
uint OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::LocalID [get] |
The local region-unique ID for this object.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
String OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::Description [get, set] |
The description assigned to this object.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
UUID OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::OwnerId [get] |
Returns the UUID of the Owner of the Object.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
UUID OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::CreatorId [get] |
Returns the UUID of the Creator of the Object.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
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.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
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.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
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.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::Scale [get, set] |
The bounding box of the object. Primitive and Mesh objects alike are scaled to fit within these bounds.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
Quaternion OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::WorldRotation [get, set] |
The rotation of the object relative to the Scene.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
Quaternion OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::OffsetRotation [get, set] |
The rotation of the object relative to a parent object If root, works the same as WorldRotation.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::OffsetPosition [get, set] |
The position of the object relative to a parent object If root, works the same as WorldPosition.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::SitTarget [get, set] |
String OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::SitTargetText [get, set] |
String OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::TouchText [get, set] |
String OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::Text [get, set] |
Text to be associated with this object, in the Second Life(r) viewer, this is shown above the object.
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::IsRotationLockedX [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::IsRotationLockedY [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::IsRotationLockedZ [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::IsSandboxed [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::IsImmotile [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::IsAlwaysReturned [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::IsTemporary [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::IsFlexible [get, set] |
IObjectShape OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::Shape [get] |
PhysicsMaterial OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::PhysicsMaterial [get, set] |
IObjectPhysics OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::Physics [get] |
IObjectSound OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::Sound [get] |
IObjectInventory OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::Inventory [get] |
Grants access to the objects inventory
Implemented in OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject.
Event Documentation
| OnTouchDelegate OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject::OnTouch |
The documentation for this interface was generated from the following file:
- /home/sdague/opensim-docsgit/opensim/OpenSim/Region/OptionalModules/Scripting/Minimodule/Interfaces/IObject.cs
