RemoveWorldModel: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (13 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function | {{Server client function}} | ||
{{Note box| | <!-- | ||
This function is used to remove a world object. | {{Note box|Pre r4844: There are two types of world objects: Binary IPL (anything not in data/maps and in gta3.img & gta_int.img) and Data IPL (anything in data/maps). Binary IPL removal requires a stream out if you are deleting anything within 300 units (anything visible) you can just move the camera to do this. Data IPL are removed instantly and this is not required. Be aware that LOD object models are not removed automatically with the model they are linked to, so you need to remove them separately.}} | ||
{{Tip| | --> | ||
This function is used to remove a world object. Use [[restoreWorldModel]] to reverse this action. | |||
<!-- | |||
{{Tip|Pre r4844: It is strongly advised that you use this server side rather than client side because it will just function infinitely better as you should not need to handle streaming it out/back in.}} | |||
--> | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool removeWorldModel ( int modelID, float radius, float x, float y, float z [, int interior = | <syntaxhighlight lang="lua">bool removeWorldModel ( int modelID, float radius, float x, float y, float z [, int interior = -1 ] )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 17: | Line 20: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{New items|3.0132|1.3.2| | {{New items|3.0132|1.3.2| | ||
*'''interior:''' The interior ID to apply the removal to | *'''interior:''' The interior ID to apply the removal to. Some objects in interior 13 show in all interiors so if you want to remove everything in interior 0 also remove everything in interior 13. A value of -1 here will affect all interiors.}} | ||
}} | |||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the | Returns ''true'' if the world object was removed, ''false'' if invalid arguments were passed. | ||
==Example== | ==Example== | ||
This example will removes buildings on BigEar: | This example will removes buildings on BigEar: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
removeWorldModel(16617,1000,-300,1556,75) --lod | removeWorldModel(16617, 1000, -300, 1556, 75) --lod | ||
removeWorldModel(16616,1000,-300,1556,75) --lod | removeWorldModel(16616, 1000, -300, 1556, 75) --lod | ||
removeWorldModel(16615,1000,-300,1556,75) --lod | removeWorldModel(16615, 1000, -300, 1556, 75) --lod | ||
removeWorldModel(16138,1000,-300,1556,75) -- model | removeWorldModel(16138, 1000, -300, 1556, 75) -- model | ||
</syntaxhighlight> | </syntaxhighlight> | ||
This example removes CJ house: | This example removes CJ house: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
for i=700, | for i = 700, 18630 do | ||
removeWorldModel(i,10,2494,-1696,17) | removeWorldModel(i, 10, 2494, -1696, 17) | ||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 44: | Line 42: | ||
This server script example removes all models, everywhere: | This server script example removes all models, everywhere: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
for i= | for i = 321, 18630 do | ||
removeWorldModel(i,10000,0,0,0) | removeWorldModel(i, 10000, 0, 0, 0) | ||
end | end | ||
setOcclusionsEnabled(false) -- Also disable occlusions when removing certain models | setOcclusionsEnabled(false) -- Also disable occlusions when removing certain models | ||
| Line 54: | Line 52: | ||
{{ChangelogHeader}} | {{ChangelogHeader}} | ||
{{ChangelogItem|1.3.1-9.04636|Added interior argument}} | {{ChangelogItem|1.3.1-9.04636|Added interior argument}} | ||
{{ChangelogItem|1.3.1-9.04844| | {{ChangelogItem|1.3.1-9.04844|Everything streams out fine now.}} | ||
==See Also== | ==See Also== | ||
===Client world functions=== | |||
{{Client_world_functions}} | {{Client_world_functions}} | ||
===Building functions=== | |||
{{Building functions}} | |||
===Object functions=== | |||
{{Object functions}} | |||
Latest revision as of 15:40, 7 November 2024
This function is used to remove a world object. Use restoreWorldModel to reverse this action.
Syntax
bool removeWorldModel ( int modelID, float radius, float x, float y, float z [, int interior = -1 ] )
Required Arguments
- modelID: A whole integer specifying the GTASA object model ID.
- radius: A floating point number representing the radius that will be eliminated.
- x: A floating point number representing the X coordinate on the map.
- y: A floating point number representing the Y coordinate on the map.
- z: A floating point number representing the Z coordinate on the map.
Optional Arguments
- interior: The interior ID to apply the removal to. Some objects in interior 13 show in all interiors so if you want to remove everything in interior 0 also remove everything in interior 13. A value of -1 here will affect all interiors.
Returns
Returns true if the world object was removed, false if invalid arguments were passed.
Example
This example will removes buildings on BigEar:
removeWorldModel(16617, 1000, -300, 1556, 75) --lod removeWorldModel(16616, 1000, -300, 1556, 75) --lod removeWorldModel(16615, 1000, -300, 1556, 75) --lod removeWorldModel(16138, 1000, -300, 1556, 75) -- model
This example removes CJ house:
for i = 700, 18630 do
removeWorldModel(i, 10, 2494, -1696, 17)
end
This server script example removes all models, everywhere:
for i = 321, 18630 do
removeWorldModel(i, 10000, 0, 0, 0)
end
setOcclusionsEnabled(false) -- Also disable occlusions when removing certain models
setWaterLevel(-5000) -- Also hide the default water as it will be full of holes
Changelog
| Version | Description |
|---|
| 1.3.1-9.04636 | Added interior argument |
| 1.3.1-9.04844 | Everything streams out fine now. |
See Also
Client world functions
- createSWATRope
- getBirdsEnabled
- getCoronaReflectionsEnabled
- getGarageBoundingBox
- getGaragePosition
- getGarageSize
- getGroundPosition
- getInteriorFurnitureEnabled
- getNearClipDistance
- getPedsLODDistance
- getRoofPosition
- getScreenFromWorldPosition
- getVehiclesLODDistance
- getWorldFromScreenPosition
- isAmbientSoundEnabled
- isLineOfSightClear
- isWorldSoundEnabled
- processLineOfSight
- resetAmbientSounds
- resetBlurLevel
- resetColorFilter
- resetCoronaReflectionsEnabled
- resetNearClipDistance
- resetPedsLODDistance
- resetVehiclesLODDistance
- resetWorldSounds
- setAmbientSoundEnabled
- setBirdsEnabled
- setColorFilter
- setCoronaReflectionsEnabled
- setInteriorFurnitureEnabled
- setInteriorSoundsEnabled
- setNearClipDistance
- setPedsLODDistance
- setVehiclesLODDistance
- setWorldSoundEnabled
- testLineAgainstWater
- areTrafficLightsLocked
- getAircraftMaxHeight
- getAircraftMaxVelocity
- getCloudsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGravity
- getHeatHaze
- getInteriorSoundsEnabled
- getJetpackMaxHeight
- getMinuteDuration
- getMoonSize
- getOcclusionsEnabled
- getRainLevel
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getWeather
- getWindVelocity
- getSkyGradient
- getPlayerBlurLevel
- getZoneName
- isGarageOpen
- removeWorldModel
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetWindVelocity
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxHeight
- setAircraftMaxVelocity
- setCloudsEnabled
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorSoundsEnabled
- setMinuteDuration
- setMoonSize
- setOcclusionsEnabled
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightState
- setTrafficLightsLocked
- setWeather
- setWeatherBlended
- setWindVelocity
- setJetpackMaxHeight
- setPlayerBlurLevel
Building functions
Object functions