Difference between revisions of "Template:LSL Constants/Object Details"

From Second Life Wiki
Jump to navigation Jump to search
m
m
Line 4: Line 4:
! title="Value" {{!}}
! title="Value" {{!}}
! class="unsortable"{{!}} Description
! class="unsortable"{{!}} Description
! class="unsortable"{{!}} Max Length
! class="unsortable"{{!}} Length when [[typecast]] to a string
! Return
! Return
! class="unsortable"{{!}} Alternatives
! class="unsortable"{{!}} Alternatives
Line 12: Line 12:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}{{#var:comment}}<br/>If '''id''' is an avatar, the {{LSLGC|Legacy Name}} is returned.  
{{!}}{{#var:comment}}<br/>If '''id''' is an avatar, the {{LSLGC|Legacy Name}} is returned.  
{{!}}63&nbsp;Characters
{{!}}max. 63 characters
{{!}}[[string]]
{{!}}[[string]]
{{!}}
{{!}}
Line 22: Line 22:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}{{#var:comment}}<br/>If '''id''' is an avatar, an empty string is returned.
{{!}}{{#var:comment}}<br/>If '''id''' is an avatar, an empty string is returned.
{{!}}127&nbsp;Characters
{{!}}max. 127 characters
{{!}}[[string]]
{{!}}[[string]]
{{!}}
{{!}}
Line 30: Line 30:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the prim's position in [[Viewer_coordinate_frames#Region|region coordinates]].<br/>If '''id''' is an avatar outside the region (see above), this position is relative to the region the script is [[llGetRegionName|running in]].
{{!}}Gets the prim's position in [[Viewer_coordinate_frames#Region|region coordinates]].<br/>If '''id''' is an avatar outside the region (see above), this position is relative to the region the script is [[llGetRegionName|running in]].
{{!}}(37&nbsp;Characters)
{{!}}max. 37 characters
{{!}}[[vector]]
{{!}}[[vector]]
{{!}}
{{!}}
Line 39: Line 39:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}{{#var:comment}}
{{!}}{{#var:comment}}
{{!}}(48&nbsp;Characters)
{{!}}max. 48 characters
{{!}}[[rotation]]
{{!}}[[rotation]]
{{!}}
{{!}}
Line 48: Line 48:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}{{#var:comment}}
{{!}}{{#var:comment}}
{{!}}(36&nbsp;Characters)
{{!}}36 characters
{{!}}[[vector]]
{{!}}[[vector]]
{{!}}
{{!}}
Line 57: Line 57:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets an object's {{LSLGC|Owner|owner}} key.<br/>If '''id''' is an avatar, that avatar's key is returned (which is the same as '''id''').<br/>If '''id''' is group-owned, a {{LSL Constant/NULL_KEY}} is returned.
{{!}}Gets an object's {{LSLGC|Owner|owner}} key.<br/>If '''id''' is an avatar, that avatar's key is returned (which is the same as '''id''').<br/>If '''id''' is group-owned, a {{LSL Constant/NULL_KEY}} is returned.
{{!}}(36&nbsp;Characters)
{{!}}36 characters
{{!}}[[key]]
{{!}}[[key]]
{{!}}
{{!}}
Line 67: Line 67:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the prim's {{LSLGC|Group|group}} key.<br/>If '''id''' is an avatar, a {{LSL Constant/NULL_KEY}} is returned.{{Footnote|There are at least 3 JIRA's about OBJECT_GROUP and avatars, LL has refused all of them. Most recently on December 5th 2013 in BUG-4654.}}
{{!}}Gets the prim's {{LSLGC|Group|group}} key.<br/>If '''id''' is an avatar, a {{LSL Constant/NULL_KEY}} is returned.{{Footnote|There are at least 3 JIRA's about OBJECT_GROUP and avatars, LL has refused all of them. Most recently on December 5th 2013 in BUG-4654.}}
{{!}}(36&nbsp;Characters)
{{!}}36 characters
{{!}}[[key]]
{{!}}[[key]]
{{!}}{{LSLGC|Group}}
{{!}}{{LSLGC|Group}}
Line 75: Line 75:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the prim's {{LSLGC|Creator|creator}} key.<br/>If '''id''' is an avatar, a {{LSL Constant/NULL_KEY}} is returned.
{{!}}Gets the prim's {{LSLGC|Creator|creator}} key.<br/>If '''id''' is an avatar, a {{LSL Constant/NULL_KEY}} is returned.
{{!}}(36&nbsp;Characters)
{{!}}36 characters
{{!}}[[key]]
{{!}}[[key]]
{{!}}{{LSLGC|Creator}}
{{!}}{{LSLGC|Creator}}
Line 83: Line 83:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the number of [[llGetScriptState|running]] scripts attached to the object or agent.
{{!}}Gets the number of [[llGetScriptState|running]] scripts attached to the object or agent.
{{!}}(11&nbsp;Characters)
{{!}}max. 11 characters
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}
{{!}}
Line 91: Line 91:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the number of scripts, both running and stopped, attached to the object or agent.
{{!}}Gets the number of scripts, both running and stopped, attached to the object or agent.
{{!}}(11&nbsp;Characters)
{{!}}max. 11 characters
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}
{{!}}
Line 99: Line 99:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the total amount of [[LSL Script Memory|script memory]] allocated to the object or agent, in bytes.
{{!}}Gets the total amount of [[LSL Script Memory|script memory]] allocated to the object or agent, in bytes.
{{!}}(11&nbsp;Characters)
{{!}}max. 11 characters
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}
{{!}}
Line 107: Line 107:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the total amount of average script CPU time used by the object or agent, in seconds.
{{!}}Gets the total amount of average script CPU time used by the object or agent, in seconds.
{{!}}(15&nbsp;Characters)
{{!}}max. 15 characters
{{!}}[[float]]
{{!}}[[float]]
{{!}}[[Viewerhelp:Top_Colliders_and_Top_Scripts|Top Scripts]]
{{!}}[[Viewerhelp:Top_Colliders_and_Top_Scripts|Top Scripts]]
Line 115: Line 115:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the prim equivalence of the object.
{{!}}Gets the prim equivalence of the object.
{{!}}(11&nbsp;Characters)
{{!}}max. 11 characters
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}[http://community.secondlife.com/t5/English-Knowledge-Base/Calculating-land-impact/ta-p/974163 Calculating land impact]
{{!}}[http://community.secondlife.com/t5/English-Knowledge-Base/Calculating-land-impact/ta-p/974163 Calculating land impact]
Line 123: Line 123:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the [[Mesh/Mesh_Server_Weight|server cost]] of the object.
{{!}}Gets the [[Mesh/Mesh_Server_Weight|server cost]] of the object.
{{!}}(15&nbsp;Characters)
{{!}}max. 15 characters
{{!}}[[float]]
{{!}}[[float]]
{{!}}[[Mesh/Mesh_Server_Weight|Server cost]]
{{!}}[[Mesh/Mesh_Server_Weight|Server cost]]
Line 131: Line 131:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the [[Mesh/Mesh_Streaming_Cost|streaming (download) cost]] of the object.
{{!}}Gets the [[Mesh/Mesh_Streaming_Cost|streaming (download) cost]] of the object.
{{!}}(15&nbsp;Characters)
{{!}}max. 15 characters
{{!}}[[float]]
{{!}}[[float]]
{{!}}[[Mesh/Mesh_Streaming_Cost|Streaming (download) cost]]
{{!}}[[Mesh/Mesh_Streaming_Cost|Streaming (download) cost]]
Line 139: Line 139:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the [[Mesh/Mesh_physics#Physics_Resource_Cost|physics cost]] of the object.
{{!}}Gets the [[Mesh/Mesh_physics#Physics_Resource_Cost|physics cost]] of the object.
{{!}}(15&nbsp;Characters)
{{!}}max. 15 characters
{{!}}[[float]]
{{!}}[[float]]
{{!}}[[Mesh/Mesh_physics|Physics cost]]
{{!}}[[Mesh/Mesh_physics|Physics cost]]
Line 147: Line 147:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the average CPU time (in seconds) used by the object for navigation, if the object is a pathfinding character. Returns 0 for non-characters.
{{!}}Gets the average CPU time (in seconds) used by the object for navigation, if the object is a pathfinding character. Returns 0 for non-characters.
{{!}}(15&nbsp;Characters)
{{!}}max. 15 characters
{{!}}[[float]]
{{!}}[[float]]
{{!}}[[Viewerhelp:Pathfinding_characters|Pathfinding characters]]
{{!}}[[Viewerhelp:Pathfinding_characters|Pathfinding characters]]
Line 154: Line 154:
{{!}}{{LSL Const|OBJECT_ROOT|integer|18|c=Gets the id of the root prim of the object requested.}}
{{!}}{{LSL Const|OBJECT_ROOT|integer|18|c=Gets the id of the root prim of the object requested.}}
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the id of the root prim of the object requested.<br/>If '''id''' is an avatar, return the id of the root prim of the linkset the avatar is sitting on (or the avatar's own id if the avatar is not sitting on an object within the region).
{{!}}Gets the id of the [[Link#Root_Prim|root prim]] of the object requested.<br/>If '''id''' is an avatar, returns the id of the [[Link#Root_Prim|root prim]] of the [[Link#Link_Set|linkset]] the avatar is sitting on and linked to (or the avatar's own id if the avatar is not sitting on an object within the region).
{{!}}(36&nbsp;Characters)
{{!}}36 characters
{{!}}[[key]]
{{!}}[[key]]
{{!}}
{{!}}
Line 163: Line 163:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the attachment point to which the object is attached.
{{!}}Gets the attachment point to which the object is attached.
{{!}}(11&nbsp;Characters)
{{!}}max. 11 characters
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}
{{!}}
Line 171: Line 171:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the pathfinding setting of the object in the region. It returns an integer matching one of the {{LSLGC|Pathfinding Types|OPT_*}} constants.
{{!}}Gets the pathfinding setting of the object in the region. It returns an integer matching one of the {{LSLGC|Pathfinding Types|OPT_*}} constants.
{{!}}(11&nbsp;Characters)
{{!}}max. 11 characters
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}[[Pathfinding_Quick_Start_Guide|Pathfinding types]]
{{!}}[[Pathfinding_Quick_Start_Guide|Pathfinding types]]
Line 179: Line 179:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the integer boolean detailing if physics is enabled or disabled on the object.<br/>If '''id''' is an {{LSLGC|Avatar|avatar}} or {{LSLGC|Attachment|attachment}}, {{HoverText|0|FALSE aka, Zero}} is returned.
{{!}}Gets the integer boolean detailing if physics is enabled or disabled on the object.<br/>If '''id''' is an {{LSLGC|Avatar|avatar}} or {{LSLGC|Attachment|attachment}}, {{HoverText|0|FALSE aka, Zero}} is returned.
{{!}}(1&nbsp;Characters)
{{!}}1 character
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}
{{!}}
Line 187: Line 187:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the integer boolean detailing if phantom is enabled or disabled on the object.<br/>If '''id''' is an {{LSLGC|Avatar|avatar}} or {{LSLGC|Attachment|attachment}}, {{HoverText|0|FALSE aka, Zero}} is returned.
{{!}}Gets the integer boolean detailing if phantom is enabled or disabled on the object.<br/>If '''id''' is an {{LSLGC|Avatar|avatar}} or {{LSLGC|Attachment|attachment}}, {{HoverText|0|FALSE aka, Zero}} is returned.
{{!}}(1&nbsp;Characters)
{{!}}1 character
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}
{{!}}
Line 195: Line 195:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}Gets the integer boolean detailing if temporary is enabled or disabled on the object.
{{!}}Gets the integer boolean detailing if temporary is enabled or disabled on the object.
{{!}}(1&nbsp;Characters)
{{!}}1 character
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}
{{!}}
Line 203: Line 203:
{{!}}{{#var:value}}
{{!}}{{#var:value}}
{{!}}{{#var:comment}}<br/>If '''id''' is an object, {{HoverText|0|FALSE aka, Zero}} is returned.  If '''id''' is an avatar whose render weight is unknown to the simulator, -1 is returned.  The maximum render weight reported by the server is 500000.
{{!}}{{#var:comment}}<br/>If '''id''' is an object, {{HoverText|0|FALSE aka, Zero}} is returned.  If '''id''' is an avatar whose render weight is unknown to the simulator, -1 is returned.  The maximum render weight reported by the server is 500000.
{{!}}6&nbsp;Characters
{{!}}max. 6 characters
{{!}}[[integer]]
{{!}}[[integer]]
{{!}}  
{{!}}  
{{!}} [[Avatar_Rendering_Cost]]
{{!}} [[Avatar_Rendering_Cost]]
{{!}}-
{{!}}- class="sortbottom"
{{!}} colspan="7" {{!}} Max Lengths in parentheses represent how many characters required when it is [[typecast]] to a string.
{{!}} style="display:none;" {{!}}
{{!}} style="display:none;" {{!}}
{{!}} style="display:none;" {{!}}
{{!}} style="display:none;" {{!}}
{{!}} style="display:none;" {{!}}
{{!}} style="display:none;" {{!}}
{{!}}}
{{!}}}

Revision as of 00:39, 31 January 2014

Flags Description Length when typecast to a string Return Alternatives Local
OBJECT_NAME 1 Gets the prim's name.
If id is an avatar, the Legacy Name is returned. 		max. 63 characters string llGetObjectName
OBJECT_DESC 2 Gets the prim's description.
If id is an avatar, an empty string is returned. 		max. 127 characters string llGetObjectDesc
OBJECT_POS 3 Gets the prim's position in region coordinates.
If id is an avatar outside the region (see above), this position is relative to the region the script is running in. 		max. 37 characters vector llGetPos
OBJECT_ROT 4 Gets the prim's rotation. max. 48 characters rotation llGetRot
OBJECT_VELOCITY 5 Gets the object's velocity. 36 characters vector llGetVel
OBJECT_OWNER 6 Gets an object's owner key.
If id is an avatar, that avatar's key is returned (which is the same as id).
If id is group-owned, a NULL_KEY is returned. 		36 characters key llGetOwner
OBJECT_GROUP 7 Gets the prim's group key.
If id is an avatar, a NULL_KEY is returned.[1] 		36 characters key Group
OBJECT_CREATOR 8 Gets the prim's creator key.
If id is an avatar, a NULL_KEY is returned. 		36 characters key Creator llGetCreator
OBJECT_RUNNING_SCRIPT_COUNT 9 Gets the number of running scripts attached to the object or agent. max. 11 characters integer llGetScriptState
OBJECT_TOTAL_SCRIPT_COUNT 10 Gets the number of scripts, both running and stopped, attached to the object or agent. max. 11 characters integer llGetInventoryNumber
OBJECT_SCRIPT_MEMORY 11 Gets the total amount of script memory allocated to the object or agent, in bytes. max. 11 characters integer
OBJECT_SCRIPT_TIME 12 Gets the total amount of average script CPU time used by the object or agent, in seconds. max. 15 characters float Top Scripts
OBJECT_PRIM_EQUIVALENCE 13 Gets the prim equivalence of the object. max. 11 characters integer Calculating land impact
OBJECT_SERVER_COST 14 Gets the server cost of the object. max. 15 characters float Server cost
OBJECT_STREAMING_COST 15 Gets the streaming (download) cost of the object. max. 15 characters float Streaming (download) cost
OBJECT_PHYSICS_COST 16 Gets the physics cost of the object. max. 15 characters float Physics cost
OBJECT_CHARACTER_TIME 17 Gets the average CPU time (in seconds) used by the object for navigation, if the object is a pathfinding character. Returns 0 for non-characters. max. 15 characters float Pathfinding characters
OBJECT_ROOT 18 Gets the id of the root prim of the object requested.
If id is an avatar, returns the id of the root prim of the linkset the avatar is sitting on and linked to (or the avatar's own id if the avatar is not sitting on an object within the region). 		36 characters key llGetLinkKey
OBJECT_ATTACHED_POINT 19 Gets the attachment point to which the object is attached. max. 11 characters integer llGetAttached
OBJECT_PATHFINDING_TYPE 20 Gets the pathfinding setting of the object in the region. It returns an integer matching one of the OPT_* constants. max. 11 characters integer Pathfinding types
OBJECT_PHYSICS 21 Gets the integer boolean detailing if physics is enabled or disabled on the object.
If id is an avatar or attachment, 0 is returned. 		1 character integer llGetStatus PRIM_PHYSICS
OBJECT_PHANTOM 22 Gets the integer boolean detailing if phantom is enabled or disabled on the object.
If id is an avatar or attachment, 0 is returned. 		1 character integer llGetStatus PRIM_PHANTOM
OBJECT_TEMP_ON_REZ 23 Gets the integer boolean detailing if temporary is enabled or disabled on the object. 1 character integer PRIM_TEMP_ON_REZ
OBJECT_RENDER_WEIGHT 24 Gets the avatar's render weight.
If id is an object, 0 is returned. If id is an avatar whose render weight is unknown to the simulator, -1 is returned. The maximum render weight reported by the server is 500000. 		max. 6 characters integer Avatar_Rendering_Cost
Retrieved from "https://wiki.secondlife.com/w/index.php?title=Template:LSL_Constants/Object_Details&oldid=1187401"