Page tree
Skip to end of metadata
Go to start of metadata



Introduced in

Version:2.12

Description

Description:Applies a mask, defined using setRenderMasking.

The mask covers all elements of the specified type with a solid color. The setting is persistent between mission restarts.

Syntax

Syntax:type setRenderMasked masked
Parameters:
  • type: String - General type of objects that should be masked. Name is case-sensitive, and can be:
    • "ground" - Solid ground, including grass (but no bushes or rocks).
    • "sky" - Sky, including clouds.
    • "water" - Open sea, lakes and rivers.
    • "staticobj" - Any objects placed on the map: Buildings, vehicles, people, trees, rocks, and so on.
  • masked: Boolean - If true, the mask is applied.
Return Value:Nothing

Alternative Syntax

Syntax:object setRenderMasked masked
Parameters:
  • object: Object - Specific objects that should be masked.
  • masked: Boolean - If true, the mask is applied.
Return Value:Nothing

Examples

Examples:
"sky" setRenderMasked true;
wall1 setRenderMasked true;

Additional Information

See also: getRenderMasked, setRenderMasking
Multiplayer:
Problems:

Notes