EntityOverlayBatch:remove
Client-Side Function
 JavaScript
|
|---|
JavaScript Syntax
This method will remove an entity from overlay batch.
Required Params
- entity: Entity
Return value
- void
Syntax
batch.remove(entity);
Example
//Enable entity overlay batch
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) => {
batch.add(vehicle);
});
//Remove vehicle from batch once the player leaves them.
mp.events.add('playerLeaveVehicle', (vehicle) => {
batch.remove(vehicle);
})