Shr0x: Created page with " {{ClientsideJsFunction}} {{JSContainer| This property will return whether an entity overlay is valid or not. Note: This property is readonly. ===Return value=== ''' {{RageType|boolean}} ''' ==Syntax== batch.valid ==Example== //Enable entity overlay mp.game.graphics.setEntityOverlayPassEnabled(true); //Create new entity overlay batch let batch = mp.game.graphics.createEntityO..."

2024-08-04T10:56:57Z

Created page with " {{ClientsideJsFunction}} {{JSContainer| This property will return whether an entity overlay is valid or not. *Note: This property is readonly. ===Return value=== *''' {{RageType|boolean}} ''' ==Syntax== <syntaxhighlight lang="javascript"> batch.valid </syntaxhighlight> ==Example== <syntaxhighlight lang="javascript"> //Enable entity overlay mp.game.graphics.setEntityOverlayPassEnabled(true); //Create new entity overlay batch let batch = mp.game.graphics.createEntityO..."

New page

{{ClientsideJsFunction}}
{{JSContainer|
This property will return whether an entity overlay is valid or not.
*Note: This property is readonly.

===Return value===
*''' {{RageType|boolean}} '''

==Syntax==
<syntaxhighlight lang="javascript">
batch.valid
</syntaxhighlight>

==Example==
<syntaxhighlight lang="javascript">
//Enable entity overlay
mp.game.graphics.setEntityOverlayPassEnabled(true);

//Create new entity overlay batch
let batch = mp.game.graphics.createEntityOverlayBatch(overlayParams);

//Add a vehicle to overlay batch once the player enters in them.
mp.events.add('playerEnterVehicle', (vehicle) => {
//check if entity overlay is valid before adding a new entity to it
if (batch.valid) {
batch.add(vehicle);
}
});

</syntaxhighlight>
}}
==See also==
{{EntityOverlayBatch}}
[[Category:Clientside API]]

EntityOverlayBatch:valid - Revision history