llSetLinkGLTFOverrides

From Second Life Wiki
Revision as of 15:57, 12 April 2025 by Rider Linden (talk | contribs) (Created page with "{{LSL_Function |inject-2={{LSL Function/color|color}}{{LSL_Function/link-face|link|face}} |func=llSetLinkGLTFOverrides |func_desc=Sets or removes individual overrides applied...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Summary

Function: llSetLinkGLTFOverrides( integer link, integer face, list params );

Sets or removes individual overrides applied to a PBR texture on a face

• integer link Link number (0: unlinked, 1: root prim, >1: child prims and seated avatars) or a LINK_* flag
• integer face face number or ALL_SIDES
• list params List of overrides and override values.

If face is ALL_SIDES then the function works on all sides.

Flag Description
LINK_ROOT 1 refers to the root prim in a multi-prim linked set[1]
LINK_SET -1 refers to all prims
LINK_ALL_OTHERS -2 refers to all other prims
Flag Description
LINK_ALL_CHILDREN -3 refers to all children, (everything but the root)
LINK_THIS -4 refers to the prim the script is in

Parameters

parameter value type description
OVERRIDE_GLTF_BASE_COLOR_FACTOR 1 vector Set the tinting color used for the base color. Color is specified in linear RGB. Use llsRGB2Linear to convert colors from BP to PBR.
OVERRIDE_GLTF_BASE_ALPHA 2 float Sets the alpha for this face. Only impacts the rendering when alphamode is blend.
OVERRIDE_GLTF_BASE_ALPHA_MODE 3 integer Set the alpha mode on the face. Must be one of the valid blend modes
GLTF Alpha Mode value description
PRIM_GLTF_ALPHA_MODE_OPAQUE 0 Ignore the alpha value and render the material as opaque.
PRIM_GLTF_ALPHA_MODE_BLEND 1 Render the material with transparency determined by the alpha value. Blending is done in linear color space. As is the case for Blinn-Phong as well, this mode suffers from depth sorting and performance issues. Use alpha mask instead when possible.
PRIM_GLTF_ALPHA_MODE_MASK 2 Render the material as fully opaque where the alpha value is greater than the alpha cutoff, and otherwise render the material as fully transparent.


OVERRIDE_GLTF_BASE_ALPHA_MASK 4 float Sets the alpha cutoff level on this face when alpha mode is set to mask.
OVERRIDE_GLTF_BASE_DOUBLE_SIDED 5 integer If set to TRUE then the texture on the specified face is considered double sided.
OVERRIDE_GLTF_METALLIC_FACTOR 6 float Adjusts the metallic factor on the specified face.
OVERRIDE_GLTF_ROUGHNESS_FACTOR 7 float Adjust the roughness factor on the specified faces.
OVERRIDE_GLTF_EMISSIVE_FACTOR 8 vector Set the tint used for the emissive texture on this face.

Passing an empty string ("") as the override value will clear that override.

Caveats

  • The function silently fails if its face value indicates a face that does not exist.

Examples

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.

See Also

Functions

•  llGetLinkNumber Returns the link number of the prim the script is in.
•  llGetLinkNumberOfSides Returns the number of faces of the linked prim.
•  LlSetPrimitiveParams Sets the parameters for a prim
•  LlGetPrimitiveParams Gets the parameters set on a prim

Articles

•  Color in LSL

Deep Notes

Footnotes

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

Signature

function void llSetLinkGLTFOverrides( integer link, integer face, list params );