Difference between revisions of "User:Strife Onizuka/PrimitiveParamsTable"

From Second Life Wiki
Jump to navigation Jump to search
m
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>__NOTOC__</noinclude>
{{#if:
{{#if:
<!-- TRM push -->
<!-- TRM push -->
{{#vardefine:TRMS|{{#var:TRM}}{{#var:TRMS}}}}  {{#vardefine:TRM|P}} {{#vardefine:PPC-1| {{{1|}}} }}
{{#vardefine:TRMS|{{#var:TRM}}{{#var:TRMS}}}}  {{#vardefine:TRM|P}} {{#vardefine:PPC-1| {{{1|}}} }}{{#vardefine:PPC-2| {{{2|}}} }}
{{#vardefine:PATH|User:Strife_Onizuka/}}


<!--{{:PRIM_NAME|{{{1|}}}}}
{{#if:{{{2|}}}|
{{:PRIM_DESC|{{{1|}}}}}
{{LSL_Function/link|{{{2|}}}|nogroup=*}}
{{:PRIM_COLOR|{{{1|}}}}}
}}
{{:PRIM_GLOW|{{{1|}}}}}
{{:PRIM_TEXTURE|{{{1|}}}}}
{{:PRIM_TEXT|{{{1|}}}}}
{{:PRIM_FULLBRIGHT|{{{1|}}}}}
{{:PRIM_TEXGEN|{{{1|}}}}}
{{:PRIM_BUMP_SHINY|{{{1|}}}}}
{{:PRIM_MATERIAL|{{{1|}}}}}
{{:PRIM_TYPE|{{{1|}}}}}
{{:PRIM_TYPE_BOX|{{{1|}}}}}
{{:PRIM_TYPE_SCULPT|{{{1|}}}}}
{{:PRIM_PHANTOM|{{{1|}}}}}
{{:PRIM_TEMP_ON_REZ|{{{1|}}}}}
{{:PRIM_PHYSICS|{{{1|}}}}}
{{:PRIM_SIZE|{{{1|}}}}}
{{:PRIM_POSITION|{{{1|}}}}}
{{:PRIM_ROTATION|{{{1|}}}}}
{{:PRIM_ROT_LOCAL|{{{1|}}}}}
{{:PRIM_FLEXIBLE|{{{1|}}}}}
{{:PRIM_POINT_LIGHT|{{{1|}}}}}


{{LSL_Function/color|color}}
{{LSL_Function/color|color}}
{{LSL_Function/alpha|alpha}}
{{LSL_Function/alpha|alpha}}
{{LSL_Function/boolean|boolean}}
{{LSL_Function/boolean|boolean}}
{{LSL_Function/face|face|flag|!footer=*|return={{#ifeq:{{{1|get}}}|get|...
{{LSL_Function/face|face|flag|!footer=*|return=nothing.}}
:{{{!}}{{Prettytable}}
{{!}}-{{Hl2}}
!{{HoverText|flag|PRIM_* flag}}
!Return if face is invalid
{{!}}-
{{#var:facetable}}
{{!}}-
{{!}}}
}}}}
-->


}}{{{!}} class="sortable" width="100%" {{Prettytable|style=margin: 0px 0px 10px 1pt;}}
}}{{{!}} class="sortable" width="100%" {{Prettytable|style=margin: 0px 0px 10px 1pt;}}
Line 56: Line 28:
! class="sortable" width="30%" {{!}} Scope
! class="sortable" width="30%" {{!}} Scope
{{!}}-
{{!}}-
{{User:Strife_Onizuka/PRIM_NAME|{{#var:PPC-1}}}}
{{{{#var:PATH}}PRIM_NAME|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{User:Strife_Onizuka/PRIM_DESC|{{#var:PPC-1}}}}
{{{{#var:PATH}}PRIM_DESC|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{User:Strife_Onizuka/PRIM_TYPE|{{#var:PPC-1}}}}
{{{{#var:PATH}}PRIM_TEXT|{{#var:PPC-1}}|{{#var:PPC-2}}}}
<!--{{PPC|{{{1|}}}|PRIM_MATERIAL|const={{#var:material_const}}|value=2|scope=prim|attr=material|[[integer]]&nbsp;{{HoverText|flag|PRIM_MATERIAL_* flag}}&nbsp;]|content={{PBR}}
{{{{#var:PATH}}PRIM_TYPE|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{LSL Constants/PrimitiveParams/materials|{{{1|}}}|style=margin:0 0 0 0; padding:0;|table=*|sortable=*}} }}
 
{{PPC|{{{1|}}}|PRIM_PHYSICS|const={{#var:physics_const}}|value=3|scope=object|qualifier=status|attr=physics|[[integer]]&nbsp;{{LSL Param|boolean}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_PHYSICS|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_TEMP_ON_REZ|const={{#var:temponrez_const}}|value=4|scope=object|attr=temporary|[[integer]]&nbsp;{{LSL Param|boolean}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_PHANTOM|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_PHANTOM|const={{#var:phantom_const}}|value=5|scope=object|qualifier=status|attr=phantom|[[integer]]&nbsp;{{LSL Param|boolean}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_TEMP_ON_REZ|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_POSITION|const={{#var:position_const}}|value=6|scope=prim|attr=position|[[vector]]&nbsp;{{LSL Param|position{{{1|}}}|position}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_MATERIAL|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_ROTATION|const={{#var:rotation_const}}|value=8|scope=prim|qualifier=rotation|attr=global|[[rotation]]&nbsp;{{LSL Param|rot}}&nbsp;]|content=}}
 
{{PPC|{{{1|}}}|PRIM_ROT_LOCAL|const={{#var:rot_local_const}}|value=29|scope=prim|qualifier=rotation|attr=local|[[rotation]]&nbsp;{{LSL Param|rot}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_SIZE|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_SIZE|const={{#var:size_const}}|value=7|scope=prim|attr=size|[[vector]]&nbsp;{{LSL Param|size}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_POSITION|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_TEXTURE|const={{#var:texture_const}}|required=[[integer]]&nbsp;{{LSL Param|face}}|value=17|scope=face|attr=texture|[[string]]&nbsp;{{LSL Param|texture}}, [[vector]]&nbsp;{{LSL Param|repeats}}, [[vector]]&nbsp;{{LSL Param|offsets}}, [[float]]&nbsp;{{LSL Param|rotation_in_radians}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_ROTATION|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_TEXT|const={{#var:text_const}}|value=26|scope=prim|attr=floating text|[[string]]&nbsp;{{LSL Param|text}}, [[vector]]&nbsp;{{LSL Param|color}}, [[float]]&nbsp;{{LSL Param|alpha}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_ROT_LOCAL|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_COLOR|const={{#var:color_const}}|required=[[integer]]&nbsp;{{LSL Param|face}}|value=18|scope=face|attr=color & alpha|[[vector]]&nbsp;{{LSL Param|color}}, [[float]]&nbsp;{{LSL Param|alpha}}&nbsp;]|content=}}
 
{{PPC|{{{1|}}}|PRIM_BUMP_SHINY|const={{#var:bumpshiny_const}}|required=[[integer]]&nbsp;{{LSL Param|face}}|value=19|scope=face|attr=shiny & bump|[[integer]]&nbsp;{{LSL Param|shiny}}, [[integer]]&nbsp;{{LSL Param|bump}}&nbsp;]|content={{PBR}}
{{{{#var:PATH}}PRIM_FLEXIBLE|{{#var:PPC-1}}|{{#var:PPC-2}}}}
<div style="display:inline-block; vertical-align: top;">{{LSL_Constants/PrimitiveParams/bump |{{{1|}}}|style=margin:1px; padding:0;|table=*|sortable=*}}</div>
{{{{#var:PATH}}PRIM_POINT_LIGHT|{{#var:PPC-1}}|{{#var:PPC-2}}}}
<div style="display:inline-block; vertical-align: top;">{{LSL_Constants/PrimitiveParams/shiny|{{{1|}}}|style=margin:1px; padding:0;|table=*|sortable=*}}</div> }}
 
{{PPC|{{{1|}}}|PRIM_POINT_LIGHT|const={{#var:light_const}}|value=23|scope=prim|attr=point light|[[integer]]&nbsp;{{LSL Param|boolean}}, [[vector]]&nbsp;{{LSL Param|color}}, [[float]]&nbsp;{{LSL Param|intensity}}, [[float]]&nbsp;{{LSL Param|radius}}, [[float]]&nbsp;{{LSL Param|falloff}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_TEXTURE|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_FULLBRIGHT|const={{#var:fullbright_const}}|required=[[integer]]&nbsp;{{LSL Param|face}}|value=20|scope=face|attr=full bright|[[integer]]&nbsp;{{LSL Param|boolean}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_TEXGEN|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_FLEXIBLE|const={{#var:flexible_const}}|value=21|scope=prim|attr=flexible|[[integer]]&nbsp;{{LSL Param|boolean}}, [[integer]]&nbsp;{{LSL Param|softness}}, [[float]]&nbsp;{{LSL Param|flex_float|gravity}}, [[float]]&nbsp;{{LSL Param|flex_float|friction}}, [[float]]&nbsp;{{LSL Param|flex_float|wind}}, [[float]]&nbsp;{{LSL Param|flex_float|tension}}, [[vector]]&nbsp;{{LSL Param|force}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_COLOR|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_TEXGEN|const={{#var:texgen_const}}|required=[[integer]]&nbsp;{{LSL Param|face}}|value=22|scope=face|attr=texture mode|[[integer]]&nbsp;{{HoverText|type|PRIM_TEXGEN_* flag}}&nbsp;]|content={{PBR}}
{{{{#var:PATH}}PRIM_GLOW|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{LSL Constants/PrimitiveParams/texgen|{{{1|}}}|style=margin:0 0 0 0; padding:0;|table=*|sortable=*}} }}
{{{{#var:PATH}}PRIM_FULLBRIGHT|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_GLOW|const={{#var:glow_const}}|required=[[integer]]&nbsp;{{LSL Param|face}}|value=25|scope=face|attr=glow|[[float]]&nbsp;{{LSL Param|intensity}}&nbsp;]|content=}}
{{{{#var:PATH}}PRIM_BUMP_SHINY|{{#var:PPC-1}}|{{#var:PPC-2}}}}
{{PPC|{{{1|}}}|PRIM_CAST_SHADOWS|const=<s>{{LSL Const|PRIM_CAST_SHADOWS|integer|24}}</s>|value=24|scope=prim|attr=cast shadow|deprecated=*|[[integer]]&nbsp;{{LSL Param|boolean}}&nbsp;]|content=}}
 
{{!}}-
{{#ifeq:{{{1|}}}|get||{{PPC|{{{1|}}}|PRIM_TYPE_LEGACY|prefix=<s>{{LSL Const|PRIM_TYPE_LEGACY|integer|1|nolink=*}}</s>|const={{HoverText|1|There is no PRIM_TYPE_LEGACY keyword!}}|value=1|scope=prim|attr=shape|deprecated=legacy mode|[[integer]]&nbsp;{{HoverText|flag|PRIM_TYPE_* flag}}&nbsp;]&nbsp;+ {{HoverText|flag_parameters|Additional parameters required by the flag, click [show]}}|content={{PBR}}
{{{!}} {{Prettytable|style=margin:0 0 0 0; padding:0;}}
{{!}}- {{Hl2}}
! colspan="2" {{!}} {{HoverText|flag|PRIM_TYPE_* flag}} Constants
! colspan="6" id="PRIM_TYPE_LEGACY_flag_parameters"{{!}} Flag Parameters
{{!}}-
{{LSL ConstTB|PRIM_TYPE_BOX|integer|0}}
{{!}} colspan="6" {{!}} [ [[vector]]&nbsp;{{LSL Param|cut}}, [[float]]&nbsp;{{LSL Param|hollow}}, [[float]]&nbsp;{{LSL Param|twist_end}}, [[vector]]&nbsp;{{LSL Param|top_size}}, [[vector]]&nbsp;{{LSL Param|top_shear}}&nbsp;]
{{!}}-
{{LSL ConstTB|PRIM_TYPE_CYLINDER|integer|1}}
{{!}} colspan="6" {{!}} [ [[vector]]&nbsp;{{LSL Param|cut}}, [[float]]&nbsp;{{LSL Param|hollow}}, [[float]]&nbsp;{{LSL Param|twist_end}}, [[vector]]&nbsp;{{LSL Param|top_size}}, [[vector]]&nbsp;{{LSL Param|top_shear}}&nbsp;]
{{!}}-
{{LSL ConstTB|PRIM_TYPE_PRISM|integer|2}}
{{!}} colspan="6" {{!}} [ [[vector]]&nbsp;{{LSL Param|cut}}, [[float]]&nbsp;{{LSL Param|hollow}}, [[float]]&nbsp;{{LSL Param|twist_end}}, [[vector]]&nbsp;{{LSL Param|top_size}}, [[vector]]&nbsp;{{LSL Param|top_shear}}&nbsp;]
{{!}}-
{{LSL ConstTB|PRIM_TYPE_SPHERE|integer|3}}
{{!}} colspan="6" {{!}} [ [[vector]]&nbsp;{{LSL Param|cut}}, [[float]]&nbsp;{{LSL Param|hollow}}, [[vector]]&nbsp;{{LSL Param|cut|dimple}}&nbsp;]
{{!}}-
{{LSL ConstTB|PRIM_TYPE_TORUS|integer|4}}
{{!}} colspan="6" {{!}} [ [[vector]]&nbsp;{{LSL Param|cut}}, [[float]]&nbsp;{{LSL Param|hollow}}, [[float]]&nbsp;{{LSL Param|twist_end}}, [[float]]&nbsp;{{LSL Param|hole_size_y}}, [[vector]]&nbsp;{{LSL Param|top_shear}}, [[vector]]&nbsp;{{LSL Param|cut|advanced_cut}}&nbsp;]
{{!}}-
{{LSL ConstTB|PRIM_TYPE_TUBE|integer|5}}
{{!}} colspan="6" {{!}} [ [[vector]]&nbsp;{{LSL Param|cut}}, [[float]]&nbsp;{{LSL Param|hollow}}, [[float]]&nbsp;{{LSL Param|twist_end}}, [[float]]&nbsp;{{LSL Param|topshear_x}}&nbsp;]
{{!}}} }} }}-->
{{!}}-
{{!}}-
{{!}}}{{#if:
{{!}}}{{#if:
Line 114: Line 61:
}}<noinclude>
}}<noinclude>
{{{{FULLPAGENAME}}|get}}
{{{{FULLPAGENAME}}|get}}
{| {{Prettytable}}
|-{{Hl2}}
! #var
! value
|-
{{VarPair|ALL_SIDES}}
|-
{{VarPair|p_face_desc}}
|-
{{VarPair|p_face_hover}}
|-
{{VarPair|p_boolean_desc}}
|-
{{VarPair|p_boolean_hover}}
|-
{{VarPair|p_alpha_desc}}
|-
{{VarPair|p_alpha_hover}}
|-
{{VarPair|p_color_desc}}
|-
{{VarPair|p_color_hover}}
|-
{{VarPair|facechoise}}
|-
{{VarPair|header_footnote}}
|-
{{VarPair|caveats}}
|-
{{VarPair|notes}}
|-
{{VarPair|spec}}
|-
{{VarPair|deepnotes}}
|}
</noinclude>
</noinclude>

Latest revision as of 19:34, 8 August 2013

User:Strife Onizuka/PRIM TEXTUser:Strife Onizuka/PRIM PHYSICSUser:Strife Onizuka/PRIM PHANTOMUser:Strife Onizuka/PRIM TEMP ON REZUser:Strife Onizuka/PRIM MATERIALUser:Strife Onizuka/PRIM SIZEUser:Strife Onizuka/PRIM POSITIONUser:Strife Onizuka/PRIM ROTATIONUser:Strife Onizuka/PRIM ROT LOCALUser:Strife Onizuka/PRIM FLEXIBLEUser:Strife Onizuka/PRIM POINT LIGHTUser:Strife Onizuka/PRIM TEXGENUser:Strife Onizuka/PRIM COLORUser:Strife Onizuka/PRIM GLOWUser:Strife Onizuka/PRIM FULLBRIGHTUser:Strife Onizuka/PRIM BUMP SHINY
V Flag Parameters Returned Scope
27 PRIM_NAME PRIM_NAME,
string name ] name - prim
Jive-icon-11x2.png

Used to get or set the prim's name.

• string name
3 name
28 PRIM_DESC PRIM_DESC,
string description ] description - prim
Jive-icon-11x2.png

Used to get or set the prim's description.

• string description
3 description
9 PRIM_TYPE PRIM_TYPE,
integer flag ] + flag_parameters shape - prim
Jive-icon-11x2.png

Gets or sets the type of the prim and associated type flag_parameters.

• integer flag PRIM_TYPE_* flag

• list flag_parameters a list consisting of the parameters for flag

The values needed for flag_parameters is dependent on flag, please refer to the individual PRIM_TYPE_* articles for additional information.

Caveats

flag Constants Additional Return Values / Flag Parameters
PRIM_TYPE_BOX 0 [ integer hole_shape, vector cut, float hollow, vector twist, vector top_size, vector top_shear ]
PRIM_TYPE_CYLINDER 1 [ integer hole_shape, vector cut, float hollow, vector twist, vector top_size, vector top_shear ]
PRIM_TYPE_PRISM 2 [ integer hole_shape, vector cut, float hollow, vector twist, vector top_size, vector top_shear ]
PRIM_TYPE_SPHERE 3 [ integer hole_shape, vector cut, float hollow, vector twist, vector dimple]
PRIM_TYPE_TORUS 4 [ integer hole_shape, vector cut, float hollow, vector twist, vector hole_size, vector top_shear, vector advanced_cut, vector taper, float revolutions, float radius_offset, float skew ]
PRIM_TYPE_TUBE 5 [ integer hole_shape, vector cut, float hollow, vector twist, vector hole_size, vector top_shear, vector advanced_cut, vector taper, float revolutions, float radius_offset, float skew ]
PRIM_TYPE_RING 6 [ integer hole_shape, vector cut, float hollow, vector twist, vector hole_size, vector top_shear, vector advanced_cut, vector taper, float revolutions, float radius_offset, float skew ]
PRIM_TYPE_SCULPT 7 [ string map, integer type ]
type Flags Style Description
PRIM_SCULPT_TYPE_SPHERE 1 Sphere Converge top & bottom, stitch left side to right
PRIM_SCULPT_TYPE_TORUS 2 Torus Stitch top to bottom, stitch left side to right
PRIM_SCULPT_TYPE_PLANE 3 Plane No stitching or converging
PRIM_SCULPT_TYPE_CYLINDER 4 Cylinder Stitch left side to right.
PRIM_SCULPT_TYPE_MESH 5 Mesh model See: Mesh
PRIM_SCULPT_FLAG_ZZZZZZZZ 63
PRIM_SCULPT_FLAG_ANIMESH 0x20 Animesh Read-only flag to query Animated mesh status.
PRIM_SCULPT_FLAG_INVERT 0x40 Invert Render inside out (inverts the normals).
PRIM_SCULPT_FLAG_MIRROR 0x80 Mirror Render an X axis mirror of the sculpty.
hole_shape Flags Shape
PRIM_HOLE_DEFAULT 0x00 Default
PRIM_HOLE_SQUARE 0x20 Square
PRIM_HOLE_CIRCLE 0x10 Circle
PRIM_HOLE_TRIANGLE 0x30 Triangle
PRIM_TYPE top_size and client taper conversion
Range[1] Top
Tapered
No
Tapering
Bottom
Tapered
Client [-1, 1] 1.0 0.0 -1.0
PRIM_TYPE [0, 2] 0.0 1.0 2.0
LEGACY [0, 1] 0.0 1.0 NA
Client < 1.11 [0, 1] 0.0 1.0 NA
3 shape
17 PRIM_TEXTURE PRIM_TEXTURE,
integer face, string texture, vector repeats, vector offsets, float rotation_in_radians ] texture - face
Jive-icon-11x2.png

Used to get or set the texture settings of a prim's face.

• integer face face number or ALL_SIDES
• string texture a texture in the inventory of the prim this script is in or a UUID of a texture
• vector repeats x and y range from 0.0 to 100, or -0.0 to -100 in 0.01 increments. Negative values flip the texture (z is ignored)
• vector offsets x and y range from -1 to 1 (z is ignored)
• float rotation_in_radians angle in radians

Caveats

  • If texture is missing from the prim's inventory and it is not a UUID or it is not a texture then an error is shouted on DEBUG_CHANNEL.
  • If texture is a UUID then there are no new asset permissions consequences for the object.
    • The resulting object develops no new usage restrictions that might have occurred if the asset had been placed in the prims inventory.


texture Constants

The following constants can (optionally) be used for the texture value: TEXTURE_BLANK, TEXTURE_DEFAULT, TEXTURE_MEDIA, TEXTURE_PLYWOOD and TEXTURE_TRANSPARENT.

Examples

<lsl>llSetPrimitiveParams([ PRIM_TEXTURE, ALL_SIDES, "5748decc-f629-461c-9a36-a35a221fe21f", <1.0, 1.0, 0.0>, <0.0, 0.0, 0.0>, 0.0 ]); llSetPrimitiveParams([ PRIM_TEXTURE, ALL_SIDES, llGetInventoryName(INVENTORY_TEXTURE, 0), <1.0, 1.0, 0.0>, <0.0, 0.0, 0.0>, 0.0 ]);

llSetPrimitiveParams([ PRIM_TEXTURE, 0, TEXTURE_PLYWOOD, <2.0, 5.0, 0.0>, <0.1, 0.2, 0.0>, 1.0 ]);</lsl>
2 texture
User:Strife Onizuka/PRIM TEXTUser:Strife Onizuka/PRIM PHYSICSUser:Strife Onizuka/PRIM PHANTOMUser:Strife Onizuka/PRIM TEMP ON REZUser:Strife Onizuka/PRIM MATERIALUser:Strife Onizuka/PRIM SIZEUser:Strife Onizuka/PRIM POSITIONUser:Strife Onizuka/PRIM ROTATIONUser:Strife Onizuka/PRIM ROT LOCALUser:Strife Onizuka/PRIM FLEXIBLEUser:Strife Onizuka/PRIM POINT LIGHTUser:Strife Onizuka/PRIM TEXGENUser:Strife Onizuka/PRIM COLORUser:Strife Onizuka/PRIM GLOWUser:Strife Onizuka/PRIM FULLBRIGHTUser:Strife Onizuka/PRIM BUMP SHINY
V Request Format Parameters Returned Scope
27 PRIM_NAME PRIM_NAME ]
string name ] name - prim
Jive-icon-11x2.png

Used to get or set the prim's name.

• string name
3 name
28 PRIM_DESC PRIM_DESC ]
string description ] description - prim
Jive-icon-11x2.png

Used to get or set the prim's description.

• string description
3 description
9 PRIM_TYPE PRIM_TYPE ]
integer flag ] + flag_parameters shape - prim
Jive-icon-11x2.png

Gets or sets the type of the prim and associated type flag_parameters.

• integer flag PRIM_TYPE_* flag

• list flag_parameters a list consisting of the parameters for flag
The values that follow after flag, the flag_parameters, are dependent on the value of flag, please refer to the individual PRIM_TYPE_* articles for further information.
flag Constants Additional Return Values
PRIM_TYPE_BOX 0 [ integer hole_shape, vector cut, float hollow, vector twist, vector top_size, vector top_shear ]
PRIM_TYPE_CYLINDER 1 [ integer hole_shape, vector cut, float hollow, vector twist, vector top_size, vector top_shear ]
PRIM_TYPE_PRISM 2 [ integer hole_shape, vector cut, float hollow, vector twist, vector top_size, vector top_shear ]
PRIM_TYPE_SPHERE 3 [ integer hole_shape, vector cut, float hollow, vector twist, vector dimple]
PRIM_TYPE_TORUS 4 [ integer hole_shape, vector cut, float hollow, vector twist, vector hole_size, vector top_shear, vector advanced_cut, vector taper, float revolutions, float radius_offset, float skew ]
PRIM_TYPE_TUBE 5 [ integer hole_shape, vector cut, float hollow, vector twist, vector hole_size, vector top_shear, vector advanced_cut, vector taper, float revolutions, float radius_offset, float skew ]
PRIM_TYPE_RING 6 [ integer hole_shape, vector cut, float hollow, vector twist, vector hole_size, vector top_shear, vector advanced_cut, vector taper, float revolutions, float radius_offset, float skew ]
PRIM_TYPE_SCULPT 7 [ string map, integer type ]
type Flags Style Description
PRIM_SCULPT_TYPE_SPHERE 1 Sphere Converge top & bottom, stitch left side to right
PRIM_SCULPT_TYPE_TORUS 2 Torus Stitch top to bottom, stitch left side to right
PRIM_SCULPT_TYPE_PLANE 3 Plane No stitching or converging
PRIM_SCULPT_TYPE_CYLINDER 4 Cylinder Stitch left side to right.
PRIM_SCULPT_TYPE_MESH 5 Mesh model See: Mesh
PRIM_SCULPT_FLAG_ZZZZZZZZ 63
PRIM_SCULPT_FLAG_ANIMESH 0x20 Animesh Read-only flag to query Animated mesh status.
PRIM_SCULPT_FLAG_INVERT 0x40 Invert Render inside out (inverts the normals).
PRIM_SCULPT_FLAG_MIRROR 0x80 Mirror Render an X axis mirror of the sculpty.
hole_shape Flags Shape
PRIM_HOLE_DEFAULT 0x00 Default
PRIM_HOLE_SQUARE 0x20 Square
PRIM_HOLE_CIRCLE 0x10 Circle
PRIM_HOLE_TRIANGLE 0x30 Triangle
PRIM_TYPE top_size and client taper conversion
Range[1] Top
Tapered
No
Tapering
Bottom
Tapered
Client [-1, 1] 1.0 0.0 -1.0
PRIM_TYPE [0, 2] 0.0 1.0 2.0
LEGACY [0, 1] 0.0 1.0 NA
Client < 1.11 [0, 1] 0.0 1.0 NA
3 shape
17 PRIM_TEXTURE PRIM_TEXTURE, integer face ]
string texture, vector repeats, vector offsets, float rotation_in_radians ] texture - face
Jive-icon-11x2.png

Used to get or set the texture settings of a prim's face.

• integer face face number or ALL_SIDES

• string texture a texture in the inventory of the prim this script is in or a UUID of a texturea texture in the inventory of the prim this script is in or a UUID of a texture
• vector repeats x and y range from 0.0 to 100, or -0.0 to -100 in 0.01 increments. Negative values flip the texture (z is ignored)x and y range from 0.0 to 100, or -0.0 to -100 in 0.01 increments. Negative values flip the texture (z is ignored)
• vector offsets x and y range from -1 to 1 (z is ignored)x and y range from -1 to 1 (z is ignored)
• float rotation_in_radians angle in radiansangle in radians
2 texture
#var value
ALL_SIDES ALL_SIDES
p_face_desc face number or ALL_SIDES
p_face_hover face number or ALL_SIDES (-1)
p_boolean_desc TRUE enables, FALSE disables
p_boolean_hover TRUE enables, FALSE disables
p_alpha_desc from 0.0 (clear) to 1.0 (solid) (0.0 <= alpha <= 1.0)
p_alpha_hover from 0.0 (clear) to 1.0 (solid) (0.0 <= alpha <= 1.0)
p_color_desc color in RGB <R, G, B> (<0.0, 0.0, 0.0> = black, <1.0, 1.0, 1.0> = white)
p_color_hover color in RGB <R, G, B> (<0.0, 0.0, 0.0> = black, <1.0, 1.0, 1.0> = white)
facechoise If face is ALL_SIDES then the function works on all sides.
header_footnote
caveats
  • If face is ALL_SIDES then the flag works on all sides.
  • If face indicates a face that does not exist the flag return is nothing.
  • If face is ALL_SIDES then the function works on all sides.
  • If face indicates a face that does not exist the return is [ "", ZERO_VECTOR, ZERO_VECTOR, 0.0 ]
  • If face is ALL_SIDES then the flag works on all sides.
  • If face indicates a face that does not exist the flag return is nothing.
  • If face is ALL_SIDES then the function works on all sides.
  • If face indicates a face that does not exist the return is [ "", ZERO_VECTOR, ZERO_VECTOR, 0.0 ]
notes
spec
deepnotes