RemoveWorldModel - Revision history

Salfi: Add a note regarding occlusions

2025-06-03T11:07:29Z

Add a note regarding occlusions

← Older revision		Revision as of 11:07, 3 June 2025
Line 5:		Line 5:
	-->		-->
	This function is used to remove a world object. Use [[restoreWorldModel]] to reverse this action.		This function is used to remove a world object. Use [[restoreWorldModel]] to reverse this action.

			{{Note\|Removing world models doesn't remove their occlusions. This may cause nearby map parts to disappear. Use [[setOcclusionsEnabled]](false) to fix it.}}
	<!--		<!--
	{{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.}}		{{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.}}

Fernando187: Remove obsolete Requirements section

2024-11-07T15:40:19Z

Remove obsolete Requirements section

← Older revision		Revision as of 15:40, 7 November 2024
Line 23:		Line 23:
	===Returns===		===Returns===
	Returns ''true'' if the world object was removed, ''false'' if invalid arguments were passed.		Returns ''true'' if the world object was removed, ''false'' if invalid arguments were passed.

	~~==Requirements==~~
	~~{{Requirements\|1.2.0-9.03618\|1.2.0-9.03618\|}}~~

	==Example==		==Example==

Fernando187 at 13:15, 23 October 2024

2024-10-23T13:15:35Z

← Older revision		Revision as of 13:15, 23 October 2024
Line 58:		Line 58:

	==See Also==		==See Also==
			===Client world functions===
	{{Client_world_functions}}		{{Client_world_functions}}
			===Building functions===
			{{Building functions}}
			===Object functions===
	{{Object functions}}		{{Object functions}}
	~~{{Building functions}}~~

Fernando187 at 13:06, 23 October 2024

2024-10-23T13:06:46Z

← Older revision		Revision as of 13:06, 23 October 2024
Line 59:		Line 59:
	==See Also==		==See Also==
	{{Client_world_functions}}		{{Client_world_functions}}
			{{Object functions}}
			{{Building functions}}

Fernando187: Add link to restore func

2024-10-22T23:14:30Z

Add link to restore func

← Older revision		Revision as of 23:14, 22 October 2024
Line 4:		Line 4:
	{{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.}}		{{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.}}
	-->		-->
	This function is used to remove a world object.		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.}}		{{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.}}

Fernando187: Fix small precision

2024-06-25T21:51:35Z

Fix small precision

← Older revision		Revision as of 21:51, 25 June 2024
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	<!--		<!--
	{{Note box\|Pre r4844: There are two types of world objects Binary IPL (anything not in data/maps and in gta3.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. ~~Also~~ LOD ~~objects~~ are not removed automatically so you need to remove them separately.}}		{{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.}}
	-->		-->
	This function is used to remove a world object.		This function is used to remove a world object.
Line 22:		Line 22:
	*'''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.}}		*'''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 [[object]] was removed, ''false'' if invalid arguments were passed.		Returns ''true'' if the world object was removed, ''false'' if invalid arguments were passed.

	==Requirements==		==Requirements==

IManGaaX at 05:21, 9 October 2023

2023-10-09T05:21:14Z

← Older revision		Revision as of 05:21, 9 October 2023
Line 38:		Line 38:
	This example removes CJ house:		This example removes CJ house:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	for i = 700, ~~19999~~ do		for i = 700, 18630 do
	removeWorldModel(i, 10, 2494, -1696, 17)		removeWorldModel(i, 10, 2494, -1696, 17)
	end		end
Line 45:		Line 45:
	This server script example removes all models, everywhere:		This server script example removes all models, everywhere:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	for i = ~~550~~, ~~19999~~ do		for i = 321, 18630 do
	removeWorldModel(i, 10000, 0, 0, 0)		removeWorldModel(i, 10000, 0, 0, 0)
	end		end

Patrick2562: /* Example */

2020-10-25T14:55:44Z

Example

← Older revision		Revision as of 14:55, 25 October 2020
Line 30:		Line 30:
	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,~~20000~~ do		for i = 700, 19999 do
	removeWorldModel(i,10,2494,-1696,17)		removeWorldModel(i, 10, 2494, -1696, 17)
	end		end
	</syntaxhighlight>		</syntaxhighlight>
Line 45:		Line 45:
	This server script example removes all models, everywhere:		This server script example removes all models, everywhere:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	for i=550,~~20000~~ do		for i = 550, 19999 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

Qaisjp: Fix default interior value (documentation was wrong)

2020-06-12T15:20:15Z

Fix default interior value (documentation was wrong)

← Older revision		Revision as of 15:20, 12 June 2020
Line 9:		Line 9:
	-->		-->
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool removeWorldModel ( int modelID, float radius, float x, float y, float z [, int interior = 0 ] )</syntaxhighlight>		<syntaxhighlight lang="lua">bool removeWorldModel ( int modelID, float radius, float x, float y, float z [, int interior = -1 ] )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
Line 20:		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 ~~( 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 )		*'''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 [[object]] was removed, ''false'' if invalid arguments were passed.		Returns ''true'' if the [[object]] was removed, ''false'' if invalid arguments were passed.

Dmitry7zip at 21:27, 6 June 2015

2015-06-06T21:27:58Z

← Older revision		Revision as of 21:27, 6 June 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function~~\|New items~~}}		{{Server client function}}
	<!--		<!--
	{{Note box\|Pre r4844: There are two types of world objects Binary IPL (anything not in data/maps and in gta3.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. Also LOD objects are not removed automatically so you need to remove them separately.}}		{{Note box\|Pre r4844: There are two types of world objects Binary IPL (anything not in data/maps and in gta3.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. Also LOD objects are not removed automatically so you need to remove them separately.}}