MTA:Eir/functions/setElementRenderMode

This function changes internal rendering properties of the GTA:SA engine. These directly influence rendering performance and rendering states. Use this function to either stylize your game environment (in addition to shaders) or increase performance by dropping unnecessary but FPS-eating effects. This function can be used to combat rendering artifacts (such as alpha issues).

Syntax

bool, string setElementRenderMode ( element theElement, string propertyName, [ string preferedValueType, ] var value )

Arguments

• theElement: the element to change a render property of
• propertyName: name of the property to adjust
• preferedValueType (optional): int, bool or float
• value: data value to apply to the given property

Valid Properties

Name	Internal Type	Description	Default Value
lighting	Boolean	This is a switch to the entire lighting status of an entity. If true, lighting calculations are allowed on the entity. Otherwise all lighting computations are dropped. Setting this flag to false for entities that never expected no lighting can cause undefined behavior.	true
lighting_ambient	Boolean	This is a switch that controls ambient lighting calculations for entities. If true, ambient lighting colors are added to the final color.	true
lighting_directional	Boolean	This is a switch that controls directional lighting calculations for entities. If true, directional lighting is added to the final color.	true
lighting_point	Boolean	This is a switch that controls point lighting calculations for entities. If true, point lighting colors are added to the final color.	true
lighting_spot	Boolean	This is a switch that controls spot lighting calculations for entities. If true, spot lighting colors are added to the entity's final color.	true
lighting_material	Boolean	This is a switch that controls special material lighting calculations for entities. If true, materials are allowed to create special light sources that affect only them. Only vehicles are using material lighting.	true
reflection	Boolean	This is a switch that controls GTA:SA reflection technology for entities. If true, the entity is allowed to display reflection effects on reflective materials. Several game objects use reflections.	true
alphaClamp	Float	This is a number that specifies the alpha value that is used for alpha testing. In the original world render mode, any pixel whose alpha value is below the alphaClamp value is cut away. Other world render modes behave smarter.	100.0f / 255.0f

Returns

Returns true if the property has been successfully set, false and a debug message otherwise.

Example

Click to collapse [-]

Client

This snippet disables mesh lighting and reflection for the player's vehicle if he executes the /unsetlight command.

addCommandHandler( "unsetlight",
    function()
        local theVehicle = getPedOccupiedVehicle( localPlayer );

        if not ( theVehicle ) then
            outputChatBox( "not in a vehicle!" );
            return;
        end
        
        -- Disable mesh lighting and reflections on it.
        setElementRenderMode( theVehicle, "lighting_mesh", false );
        setElementRenderMode( theVehicle, "reflection", false );
    end
);