Difference between revisions of "PRIM RENDER MATERIAL"

From Second Life Wiki
Jump to navigation Jump to search
m
(Disambiguate the param "render_material" from the "material" inventory asset type)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{hint
|mode=warning
|title_desc=Future feature
|desc=This function will be supported in the upcoming GLTF Materials project.</b><br/>Currently it will only work in supported testing areas with a supported test viewer.
}}
<onlyinclude>{{#if:
<onlyinclude>{{#if:


{{#vardefine:render_material_return|an empty list.}}
{{#vardefine:render_material_return|an empty list.}}


{{#vardefine:render_material_const|{{LSL Const|PRIM_RENDER_MATERIAL|integer|43|c=Used to {{GetSet|{{{1|}}}|get|set|/}} the render_material settings of a prim's face}}}}
{{#vardefine:render_material_const|{{LSL Const|PRIM_RENDER_MATERIAL|integer|43|c=Used to {{GetSet|{{{1|}}}|get|set|/}} the material settings of a prim's face}}}}


{{LSL_Function/inventory|render_material|uuid=true|type=render_material|no_caveat={{#ifeq:{{{1|}}}|get|true|<noinclude>*</noinclude>}}|full={{{remote|}}}|remote={{#ifeq:{{{1|set}}}|get|*}}|target=PRIM_RENDER_MATERIAL#Target}}
{{LSL_Function/inventory|render_material|uuid=true|type=material|no_caveat={{#ifeq:{{{1|}}}|get|true|<noinclude>*</noinclude>}}|full={{{remote|}}}|remote={{#ifeq:{{{1|set}}}|get|*}}|target=PRIM_RENDER_MATERIAL#Target}}


{{#ifeq:{{{1|}}}|none||
{{#ifeq:{{{1|}}}|none||
Line 15: Line 20:


{{#vardefine:caveats_get|
{{#vardefine:caveats_get|
* With {{LSLP|render_material}} as with [[llGetRenderMaterial]], {{LSL Constant/NULL KEY}} is returned when the {{LSLGC|Owner|owner}} does not have {{LSLGC|Permissions/Asset|full permissions}} to the object and the [[PRIM_RENDER_MATERIAL|render_material]] is not in the prim's inventory.}}
* With {{LSLP|render_material}} as with [[llGetRenderMaterial]], {{LSL Constant/NULL KEY}} is returned when the {{LSLGC|Owner|owner}} does not have {{LSLGC|Permissions/Asset|full permissions}} to the object and the [[PRIM_RENDER_MATERIAL|material]] is not in the prim's inventory.}}


{{#ifeq:{{{1|}}}|get|
{{#ifeq:{{{1|}}}|get|
Line 58: Line 63:
|type=integer
|type=integer
|value=43
|value=43
|desc=Used to get or set the render_material settings of a prim's {{LSLP|face}}.
|desc=Used to get or set the material settings of a prim's {{LSLP|face}}.
|examples=
|examples=
|pa={{LSL Constant/List|i_front=[&#32;{{#var:render_material_const}},&#32;|i_end=&nbsp;]|
|pa={{LSL Constant/List|i_front=[&#32;{{#var:render_material_const}},&#32;|i_end=&nbsp;]|
Line 64: Line 69:
{{#vardefine:p_render_material_hover|}}
{{#vardefine:p_render_material_hover|}}
{{#vardefine:direction|_set}}
{{#vardefine:direction|_set}}
{{LSL_Function/inventory|render_material|uuid=true|type=render_material}}
{{LSL_Function/inventory|render_material|uuid=true|type=material}}
|text=Used with [[llSetPrimitiveParams]] & [[llSetLinkPrimitiveParams]].
|text=Used with [[llSetPrimitiveParams]] & [[llSetLinkPrimitiveParams]].


Line 82: Line 87:
{{#vardefine:p_render_material_hover|}}
{{#vardefine:p_render_material_hover|}}
{{#vardefine:direction|_get}}
{{#vardefine:direction|_get}}
{{LSL_Function/inventory|render_material|uuid=true|type=render_material|no_caveat=true|full={{{remote|}}}|remote=*|target=#Target}}
{{LSL_Function/inventory|render_material|uuid=true|type=material|no_caveat=true|full={{{remote|}}}|remote=*|target=#Target}}
{{LSL Function/link|link|nogroup=*|nocaveats=*}}
{{LSL Function/link|link|nogroup=*|nocaveats=*}}
|r_front=Returns the list [&nbsp;|r_end=&nbsp;]
|r_front=Returns the list [&nbsp;|r_end=&nbsp;]

Latest revision as of 13:22, 5 October 2022

Emblem-important-red.png Warning! Future feature

This function will be supported in the upcoming GLTF Materials project.
Currently it will only work in supported testing areas with a supported test viewer.

Description

Constant: integer PRIM_RENDER_MATERIAL = 43;

The integer constant PRIM_RENDER_MATERIAL has the value 43

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

llSetPrimitiveParams

[ PRIM_RENDER_MATERIAL, integer face, string render_material ]
• integer face face number or ALL_SIDES
• string render_material a material in the inventory of the prim this script is in or a UUID of a material

Used with llSetPrimitiveParams & llSetLinkPrimitiveParams.

Caveats

  • If render_material is missing from the prim's inventory and it is not a UUID or it is not a material then an error is shouted on DEBUG_CHANNEL.
  • If render_material 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.
All Issues ~ Search JIRA for related Bugs

Examples

llSetPrimitiveParams([ PRIM_RENDER_MATERIAL, ALL_SIDES, my_render_material ]);
llSetPrimitiveParams([ PRIM_RENDER_MATERIAL, ALL_SIDES, llGetInventoryName(INVENTORY_RENDER_MATERIAL, 0) ]);
llSetPrimitiveParams([ PRIM_RENDER_MATERIAL, 0, my_render_material ]);

llGetPrimitiveParams

llGetPrimitiveParams([ PRIM_RENDER_MATERIAL, integer face ]);

Returns the list [ string render_material ]

• integer face face number or ALL_SIDES

• string render_material a material in the inventory of the target prim or a UUID of a material

Caveats

All Issues ~ Search JIRA for related Bugs

Target

In the case of llGetPrimitiveParams is either the prim the script resides in, or the prim specified by the immediately prior PRIM_LINK_TARGET call. However in the case of llGetLinkPrimitiveParams, it is either the value of the link parameter, or the prim specified by the immediately prior PRIM_LINK_TARGET call.

Related Articles

Constants

•  CHANGED_RENDER_MATERIAL

Functions

•  llSetPrimitiveParams
•  llSetLinkPrimitiveParams
•  llGetPrimitiveParams
•  llSetRenderMaterial
•  llSetLinkRenderMaterial
•  llGetLinkNumber Returns the link number of the prim the script is in.

Events

•  changed

Notes

Link Numbers

Each prim that makes up an object has an address, a link number. To access a specific prim in the object, the prim's link number must be known. In addition to prims having link numbers, avatars seated upon the object do as well.

  • If an object consists of only one prim, and there are no avatars seated upon it, the (root) prim's link number is zero.
  • However, if the object is made up of multiple prims or there is an avatar seated upon the object, the root prim's link number is one.

When an avatar sits on an object, it is added to the end of the link set and will have the largest link number. In addition to this, while an avatar is seated upon an object, the object is unable to link or unlink prims without unseating all avatars first.

Counting Prims & Avatars

There are two functions of interest when trying to find the number of prims and avatars on an object.

integer GetPrimCount() { //always returns only the number of prims
    if(llGetAttached())//Is it attached?
        return llGetNumberOfPrims();//returns avatars and prims but attachments can't be sat on.
    return llGetObjectPrimCount(llGetKey());//returns only prims but won't work on attachments.
}
See llGetNumberOfPrims for more about counting prims and avatars.

Errata

If a script located in a child prim erroneously attempts to access link 0, it will get or set the property of the linkset's root prim. This bug (BUG-5049) is preserved for broken legacy scripts.

Deep Notes

Search JIRA for related Issues

Footnotes

  1. ^ LINK_ROOT does not work on single prim objects. Unless there is an avatar sitting on the object.

Signature

integer PRIM_RENDER_MATERIAL = 43;