Graphics::createEntityOverlayBatch: Difference between revisions

From RAGE Multiplayer Wiki
(Created page with " {{ClientsideJsFunction}} {{JSContainer| Overlay Params <pre> { enableDepth: boolean, deleteWhenUnused: boolean, keepNonBlurred: boolean, processAttachments: boolean, fill: { enable: boolean, color: 0xhex }, noise: { enable: boolean, size: number, speed: number, intensity: number }, outline: { enable: boolean, color: 0xhex, width: number, blurRadius: number, blurIntensity: number }, wireframe: { enable: boolean } } </pre> ===Required Par...")
 
 
(One intermediate revision by the same user not shown)
Line 21: Line 21:


===Return value===
===Return value===
*''' {{RageType|number}} '''
*''' {{RageType|object}} '''


==Syntax==
==Syntax==
Line 51: Line 51:
}}
}}
==See also==
==See also==
{{EntityOverlayBatch}}
{{Graphics_functions_c}}
{{Graphics_functions_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]

Latest revision as of 19:57, 3 August 2024

Client-Side
Function

 JavaScript



JavaScript Syntax


Overlay Params 

{
    enableDepth: boolean,
    deleteWhenUnused: boolean,
    keepNonBlurred: boolean,
    processAttachments: boolean,
    fill: { enable: boolean, color: 0xhex },
    noise: { enable: boolean, size: number, speed: number, intensity: number },
    outline: { enable: boolean, color: 0xhex, width: number, blurRadius: number, blurIntensity: number },
    wireframe: { enable: boolean }
}

Required Params

  • overlayParams: object

Return value

  • object

Syntax

mp.game.graphics.createEntityOverlayBatch(overlayParams)

Example

let overlayParams = {
    enableDepth: true,
    deleteWhenUnused: false,
    keepNonBlurred: true,
    processAttachments: true,
    fill: { enable: false, color: 0xFFFFFFFF },
    noise: { enable: false, size: 0.0, speed: 0.0, intensity: 0.0 },
    outline: { enable: true, color: 0xFF9000FF, width: 5.0, blurRadius: 1.0, blurIntensity: 1.0 },
    wireframe: { enable: false }
};

mp.game.graphics.setEntityOverlayPassEnabled(true);

let batch = mp.game.graphics.createEntityOverlayBatch(overlayParams);

mp.events.add('render', () => {
    batch.addThisFrame(mp.players.local);
});


See also

Retrieved from "https://wiki.rage.mp/w/index.php?title=Graphics::createEntityOverlayBatch&oldid=26298"