OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject Class Reference
Public Member Functions | |
| SOPObject (Scene rootScene, uint localID) | |
| SOPObject (Scene rootScene, uint localID, ISecurityCredential credential) | |
| 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. | |
| void | AddForce (Vector3 force, bool pushforce) |
| void | AddAngularForce (Vector3 force, bool pushforce) |
| void | SetMomentum (Vector3 momentum) |
| void | Play (UUID asset, double volume) |
Properties | |
| OnTouchDelegate | OnTouch |
| 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. | |
| UUID | GlobalID [get] |
| string | Name [get, set] |
| 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[] | Children [get] |
| Returns a collection of objects which are linked to the current object. Does not include the root object. | |
| IObject | Root [get] |
| Returns the root object of a linkset. If this object is the root, it will return itself. | |
| 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 | WorldPosition [get, set] |
| 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] |
| PhysicsMaterial | PhysicsMaterial [get, set] |
| IObjectPhysics | Physics [get] |
| IObjectShape | Shape [get] |
| IObjectInventory | Inventory [get] |
| bool | Enabled [get, set] |
| bool | Phantom [get, set] |
| bool | PhantomCollisions [get, set] |
| double | Density [get, set] |
| double | Mass [get, set] |
| double | Buoyancy [get, set] |
| Vector3 | GeometricCenter [get] |
| Vector3 | CenterOfMass [get] |
| Vector3 | RotationalVelocity [get, set] |
| Vector3 | Velocity [get, set] |
| Vector3 | Torque [get, set] |
| Vector3 | Acceleration [get] |
| Vector3 | Force [get, set] |
| bool | FloatOnWater [set] |
| UUID | SculptMap [get, set] |
| SculptType | SculptType [get, set] |
| HoleShape | HoleType [get, set] |
| double | HoleSize [get, set] |
| PrimType | PrimType [get, set] |
| IObjectSound | Sound [get] |
Constructor & Destructor Documentation
| OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::SOPObject | ( | Scene | rootScene, | |
| uint | localID | |||
| ) | [inline] |
| OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::SOPObject | ( | Scene | rootScene, | |
| uint | localID, | |||
| ISecurityCredential | credential | |||
| ) | [inline] |
Member Function Documentation
| void OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Say | ( | string | msg | ) | [inline] |
Causes the object to speak to its surroundings, equivilent to LSL/OSSL llSay.
- Parameters:
-
msg The message to send to the user
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
| void OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Say | ( | string | msg, | |
| int | channel | |||
| ) | [inline] |
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
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
| void OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Dialog | ( | UUID | avatar, | |
| string | message, | |||
| string[] | buttons, | |||
| int | chat_channel | |||
| ) | [inline] |
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
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
| void OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::AddForce | ( | Vector3 | force, | |
| bool | pushforce | |||
| ) | [inline] |
| void OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::AddAngularForce | ( | Vector3 | force, | |
| bool | pushforce | |||
| ) | [inline] |
| void OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::SetMomentum | ( | Vector3 | momentum | ) | [inline] |
| void OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Play | ( | UUID | asset, | |
| double | volume | |||
| ) | [inline] |
Property Documentation
OnTouchDelegate OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::OnTouch [add, remove] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::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.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
uint OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::LocalID [get] |
The local region-unique ID for this object.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
UUID OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::GlobalID [get] |
string OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Name [get, set] |
string OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Description [get, set] |
The description assigned to this object.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
UUID OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::OwnerId [get] |
Returns the UUID of the Owner of the Object.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
UUID OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::CreatorId [get] |
Returns the UUID of the Creator of the Object.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
IObject [] OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Children [get] |
Returns a collection of objects which are linked to the current object. Does not include the root object.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
IObject OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Root [get] |
Returns the root object of a linkset. If this object is the root, it will return itself.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
IObjectMaterial [] OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::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.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Scale [get, set] |
The bounding box of the object. Primitive and Mesh objects alike are scaled to fit within these bounds.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
Quaternion OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::WorldRotation [get, set] |
The rotation of the object relative to the Scene.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
Quaternion OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::OffsetRotation [get, set] |
The rotation of the object relative to a parent object If root, works the same as WorldRotation.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::WorldPosition [get, set] |
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::OffsetPosition [get, set] |
The position of the object relative to a parent object If root, works the same as WorldPosition.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::SitTarget [get, set] |
string OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::SitTargetText [get, set] |
string OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::TouchText [get, set] |
string OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Text [get, set] |
Text to be associated with this object, in the Second Life(r) viewer, this is shown above the object.
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::IsRotationLockedX [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::IsRotationLockedY [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::IsRotationLockedZ [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::IsSandboxed [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::IsImmotile [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::IsAlwaysReturned [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::IsTemporary [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::IsFlexible [get, set] |
PhysicsMaterial OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::PhysicsMaterial [get, set] |
IObjectPhysics OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Physics [get] |
IObjectShape OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Shape [get] |
IObjectInventory OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Inventory [get] |
Grants access to the objects inventory
Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IObject.
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Enabled [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Phantom [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::PhantomCollisions [get, set] |
double OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Density [get, set] |
double OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Mass [get, set] |
double OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Buoyancy [get, set] |
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::GeometricCenter [get] |
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::CenterOfMass [get] |
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::RotationalVelocity [get, set] |
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Velocity [get, set] |
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Torque [get, set] |
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Acceleration [get] |
Vector3 OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Force [get, set] |
bool OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::FloatOnWater [set] |
UUID OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::SculptMap [get, set] |
SculptType OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::SculptType [get, set] |
HoleShape OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::HoleType [get, set] |
double OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::HoleSize [get, set] |
PrimType OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::PrimType [get, set] |
IObjectSound OpenSim::Region::OptionalModules::Scripting::Minimodule::SOPObject::Sound [get] |
The documentation for this class was generated from the following file:
- /home/sdague/opensim-docsgit/opensim/OpenSim/Region/OptionalModules/Scripting/Minimodule/SOPObject.cs
