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

From Second Life Wiki
Jump to navigation Jump to search
m
m
Line 56: Line 56:
{{!}}-
{{!}}-
{{User:Strife_Onizuka/PRIM_NAME|{{#var:PPC-1}}}}
{{User:Strife_Onizuka/PRIM_NAME|{{#var:PPC-1}}}}
{{PPC|{{{1|}}}|PRIM_DESC|const={{#var:desc_const}}|value=28|scope=prim|attr=description|[[string]] {{LSL Param|description}} ]}}
{{User:Strife_Onizuka/PRIM_DESC|{{#var:PPC-1}}}}
{{PPC|{{{1|}}}|PRIM_TYPE|const={{#var:type_const}}|value=9|scope=prim|attr=shape|[[integer]] {{HoverText|flag|PRIM_TYPE_* flag}} ] + {{HoverText|flag_parameters|Additional parameters required by the flag, click [show]}}|content={{PBR}}
{{User:Strife_Onizuka/PRIM_TYPE|{{#var:PPC-1}}}}
<div style="display:inline-block; vertical-align: top;">{{LSL_Constants/PrimitiveParams/type        |{{{1|}}}|style=margin:1px; padding:0;|table=*|sortable=*|simple=*}}</div>
<div style="display:inline-block; vertical-align: top;">{{LSL Constants/PrimitiveParams/sculpt types|{{{1|}}}style=margin:1px; padding:0;|table=*|sortable=*}}</div>
<div style="display:inline-block; vertical-align: top;">{{LSL_Constants/PrimitiveParams/holeshape  |{{{1|}}}style=margin:1px; padding:0;|table=*|sortable=*}}</div> }}
{{PPC|{{{1|}}}|PRIM_MATERIAL|const={{#var:material_const}}|value=2|scope=prim|attr=material|[[integer]]&nbsp;{{HoverText|flag|PRIM_MATERIAL_* flag}}&nbsp;]|content={{PBR}}
{{PPC|{{{1|}}}|PRIM_MATERIAL|const={{#var:material_const}}|value=2|scope=prim|attr=material|[[integer]]&nbsp;{{HoverText|flag|PRIM_MATERIAL_* flag}}&nbsp;]|content={{PBR}}
{{LSL Constants/PrimitiveParams/materials|{{{1|}}}|style=margin:0 0 0 0; padding:0;|table=*|sortable=*}} }}
{{LSL Constants/PrimitiveParams/materials|{{{1|}}}|style=margin:0 0 0 0; padding:0;|table=*|sortable=*}} }}

Revision as of 23:04, 18 November 2010

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

  • Depending upon the situation position may need to be in local coordinates or region coordinates, See llSetPos#Specification for details.
    • It is usually not a good idea to combine PRIM_POSITION with LINK_SET. The root will treat the coordinates as world or attachment, while the children will treat them as local, yielding inconsistent results or failure. If you want to move the object as a unit, use LINK_ROOT instead.
  • The range the prim can move is limited if it is an unattached root prim. The distance is capped to 10m per PRIM_POSITION call. See WarpPos. This is a very special case. Do not rely on rule duplication of other flags - the results are undefined, and things will break in the future.
  • Moving avatars with PRIM_POSITION
    • Moving the prim the avatar sat upon does not move the avatar.
    • Moving an avatar does not move the prim they sat upon.
    • Sit-target coordinates do not easily map to prim coordinates, use UpdateSitTarget.
    • If you have explicitally set your object as "static obstacle" for pathfinding , the function will fail with the error in the debug channel : "Unable to set prim position or scale: object contributes to the navmesh."
    • If position is greater than 54 meters away from the center, the repositioning will silently fail.
  • PRIM_TYPE can only be used with LINK_SET if the object contains 10 or fewer prims. It can only be used with LINK_ALL_OTHERS or LINK_ALL_CHILDREN if the object contains 11 or fewer prims. If there are more prims, the operation will fail and an error will be shouted to DEBUG_CHANNEL. Work around this by looping through the prims with llSetLinkPrimitiveParamsFast.
All Issues ~ Search JIRA for related Bugs
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 mapinteger 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[3] 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
2 PRIM_MATERIAL PRIM_MATERIAL,
integer flag ] ] material - prim
Jive-icon-11x2.png

material Flags Description Friction Restitution
PRIM_MATERIAL_STONE 0 stone 0.8 0.4
PRIM_MATERIAL_METAL 1 metal 0.3 0.4
PRIM_MATERIAL_GLASS 2 glass 0.2 0.7
PRIM_MATERIAL_WOOD 3 wood 0.6 0.5
PRIM_MATERIAL_FLESH 4 flesh 0.9 0.3
PRIM_MATERIAL_PLASTIC 5 plastic 0.4 0.7
PRIM_MATERIAL_RUBBER 6 rubber 0.9 0.9
PRIM_MATERIAL_LIGHT 7 light, DEPRECATED: Looks the same as [ PRIM_FULLBRIGHT, ALL_SIDES, TRUE ] 0.6 0.5
3 material
3 PRIM_PHYSICS PRIM_PHYSICS,
integer boolean ] ] physics status - object
4 status physics
4 PRIM_TEMP_ON_REZ PRIM_TEMP_ON_REZ,
integer boolean ] ] temporary - object
4 temporary
5 PRIM_PHANTOM PRIM_PHANTOM,
integer boolean ] ] phantom status - object
4 status phantom
6 PRIM_POSITION PRIM_POSITION,
vector position ] ] position - prim
3 position
8 PRIM_ROTATION PRIM_ROTATION,
rotation rot ] ] global rotation - prim
3 rotation global
29 PRIM_ROT_LOCAL PRIM_ROT_LOCAL,
rotation rot ] ] local rotation - prim
3 rotation local
7 PRIM_SIZE PRIM_SIZE,
vector size ] ] size - prim
3 size
17 PRIM_TEXTURE PRIM_TEXTURE,
integer face, string texture, vector repeats, vector offsets, float rotation_in_radians ] ] texture - face
2 texture
26 PRIM_TEXT PRIM_TEXT,
string text, vector color, float alpha ] ] floating text - prim
3 floating text
18 PRIM_COLOR PRIM_COLOR,
integer face, vector color, float alpha ] ] color & alpha - face
2 color & alpha
19 PRIM_BUMP_SHINY PRIM_BUMP_SHINY,
integer face, integer shiny, integer bump ] ] shiny & bump - face
Jive-icon-11x2.png

bump Flags Description
PRIM_BUMP_NONE 0 none: no bump map
PRIM_BUMP_BRIGHT 1 brightness: generate from highlights
PRIM_BUMP_DARK 2 darkness: generate from lowlights
PRIM_BUMP_WOOD 3 woodgrain
PRIM_BUMP_BARK 4 bark
PRIM_BUMP_BRICKS 5 bricks
PRIM_BUMP_CHECKER 6 checker
PRIM_BUMP_CONCRETE 7 concrete
PRIM_BUMP_TILE 8 crustytile
PRIM_BUMP_STONE 9 cutstone: blocks
PRIM_BUMP_DISKS 10 discs: packed circles
PRIM_BUMP_GRAVEL 11 gravel
PRIM_BUMP_BLOBS 12 petridish: blobby amoeba like shapes
PRIM_BUMP_SIDING 13 siding
PRIM_BUMP_LARGETILE 14 stonetile
PRIM_BUMP_STUCCO 15 stucco
PRIM_BUMP_SUCTION 16 suction: rings
PRIM_BUMP_WEAVE 17 weave
shiny Flags Description
PRIM_SHINY_NONE 0 none
PRIM_SHINY_LOW 1 low
PRIM_SHINY_MEDIUM 2 medium
PRIM_SHINY_HIGH 3 high
2 shiny & bump
23 PRIM_POINT_LIGHT PRIM_POINT_LIGHT,
integer boolean, vector color, float intensity, float radius, float falloff ] ] point light - prim
3 point light
20 PRIM_FULLBRIGHT PRIM_FULLBRIGHT,
integer face, integer boolean ] ] full bright - face
2 full bright
21 PRIM_FLEXIBLE PRIM_FLEXIBLE,
integer boolean, integer softness, float gravity, float friction, float wind, float tension, vector force ] ] flexible - prim
3 flexible
22 PRIM_TEXGEN PRIM_TEXGEN,
integer face, integer type ] ] texture mode - face
Jive-icon-11x2.png

mode Constants Description
PRIM_TEXGEN_DEFAULT 0 The texture repeats units are in texture repeats per face.
PRIM_TEXGEN_PLANAR 1 The texture repeats units are in texture repeats per half meter. This is in contrast to the in-world editing tool, in which the planar texture scaling units are repeats per meter.
2 texture mode
25 PRIM_GLOW PRIM_GLOW,
integer face, float intensity ] ] glow - face
2 glow
24 PRIM_CAST_SHADOWS PRIM_CAST_SHADOWS,
integer boolean ] ] (DEPRECATED) - cast shadow - prim
3 cast shadow *
1 PRIM_TYPE_LEGACY PRIM_TYPE_LEGACY1,
integer flag ] + flag_parameters ] (DEPRECATED) - shape - prim
Jive-icon-11x2.png

flag Constants Flag Parameters
PRIM_TYPE_BOX 0 [ vector cut, float hollow, float twist_end, vector top_size, vector top_shear ]
PRIM_TYPE_CYLINDER 1 [ vector cut, float hollow, float twist_end, vector top_size, vector top_shear ]
PRIM_TYPE_PRISM 2 [ vector cut, float hollow, float twist_end, vector top_size, vector top_shear ]
PRIM_TYPE_SPHERE 3 [ vector cut, float hollow, vector dimple ]
PRIM_TYPE_TORUS 4 [ vector cut, float hollow, float twist_end, float hole_size_y, vector top_shear, vector advanced_cut ]
PRIM_TYPE_TUBE 5 [ vector cut, float hollow, float twist_end, float topshear_x ]
3 shape legacy mode
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 mapinteger 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[3] 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
2 PRIM_MATERIAL PRIM_MATERIAL ]
integer flag ] ] material - prim
Jive-icon-11x2.png

material Flags Description Friction Restitution
PRIM_MATERIAL_STONE 0 stone 0.8 0.4
PRIM_MATERIAL_METAL 1 metal 0.3 0.4
PRIM_MATERIAL_GLASS 2 glass 0.2 0.7
PRIM_MATERIAL_WOOD 3 wood 0.6 0.5
PRIM_MATERIAL_FLESH 4 flesh 0.9 0.3
PRIM_MATERIAL_PLASTIC 5 plastic 0.4 0.7
PRIM_MATERIAL_RUBBER 6 rubber 0.9 0.9
PRIM_MATERIAL_LIGHT 7 light, DEPRECATED: Looks the same as [ PRIM_FULLBRIGHT, ALL_SIDES, TRUE ] 0.6 0.5
3 material
3 PRIM_PHYSICS PRIM_PHYSICS ]
integer boolean ] ] physics status - object
4 status physics
4 PRIM_TEMP_ON_REZ PRIM_TEMP_ON_REZ ]
integer boolean ] ] temporary - object
4 temporary
5 PRIM_PHANTOM PRIM_PHANTOM ]
integer boolean ] ] phantom status - object
4 status phantom
6 PRIM_POSITION PRIM_POSITION ]
vector position ] ] position - prim
3 position
8 PRIM_ROTATION PRIM_ROTATION ]
rotation rot ] ] global rotation - prim
3 rotation global
29 PRIM_ROT_LOCAL PRIM_ROT_LOCAL ]
rotation rot ] ] local rotation - prim
3 rotation local
7 PRIM_SIZE PRIM_SIZE ]
vector size ] ] size - prim
3 size
17 PRIM_TEXTURE PRIM_TEXTURE, integer face ]
string texture, vector repeats, vector offsets, float rotation_in_radians ] ] texture - face
2 texture
26 PRIM_TEXT PRIM_TEXT ]
string text, vector color, float alpha ] ] floating text - prim
3 floating text
18 PRIM_COLOR PRIM_COLOR, integer face ]
vector color, float alpha ] ] color & alpha - face
2 color & alpha
19 PRIM_BUMP_SHINY PRIM_BUMP_SHINY, integer face ]
integer shiny, integer bump ] ] shiny & bump - face
Jive-icon-11x2.png

bump Flags Description
PRIM_BUMP_NONE 0 none: no bump map
PRIM_BUMP_BRIGHT 1 brightness: generate from highlights
PRIM_BUMP_DARK 2 darkness: generate from lowlights
PRIM_BUMP_WOOD 3 woodgrain
PRIM_BUMP_BARK 4 bark
PRIM_BUMP_BRICKS 5 bricks
PRIM_BUMP_CHECKER 6 checker
PRIM_BUMP_CONCRETE 7 concrete
PRIM_BUMP_TILE 8 crustytile
PRIM_BUMP_STONE 9 cutstone: blocks
PRIM_BUMP_DISKS 10 discs: packed circles
PRIM_BUMP_GRAVEL 11 gravel
PRIM_BUMP_BLOBS 12 petridish: blobby amoeba like shapes
PRIM_BUMP_SIDING 13 siding
PRIM_BUMP_LARGETILE 14 stonetile
PRIM_BUMP_STUCCO 15 stucco
PRIM_BUMP_SUCTION 16 suction: rings
PRIM_BUMP_WEAVE 17 weave
shiny Flags Description
PRIM_SHINY_NONE 0 none
PRIM_SHINY_LOW 1 low
PRIM_SHINY_MEDIUM 2 medium
PRIM_SHINY_HIGH 3 high
2 shiny & bump
23 PRIM_POINT_LIGHT PRIM_POINT_LIGHT ]
integer boolean, vector color, float intensity, float radius, float falloff ] ] point light - prim
3 point light
20 PRIM_FULLBRIGHT PRIM_FULLBRIGHT, integer face ]
integer boolean ] ] full bright - face
2 full bright
21 PRIM_FLEXIBLE PRIM_FLEXIBLE ]
integer boolean, integer softness, float gravity, float friction, float wind, float tension, vector force ] ] flexible - prim
3 flexible
22 PRIM_TEXGEN PRIM_TEXGEN, integer face ]
integer type ] ] texture mode - face
Jive-icon-11x2.png

mode Constants Description
PRIM_TEXGEN_DEFAULT 0 The texture repeats units are in texture repeats per face.
PRIM_TEXGEN_PLANAR 1 The texture repeats units are in texture repeats per half meter. This is in contrast to the in-world editing tool, in which the planar texture scaling units are repeats per meter.
2 texture mode
25 PRIM_GLOW PRIM_GLOW, integer face ]
float intensity ] ] glow - face
2 glow
24 PRIM_CAST_SHADOWS PRIM_CAST_SHADOWS ]
integer boolean ] ] (DEPRECATED) - cast shadow - prim
3 cast shadow *