RemoveWorldModel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server client function|New items}}
{{Server client function|New items}}
{{Note box|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|Post 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.}}
This function is used to remove a world object.
This function is used to remove a world object.
{{Tip|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|Post 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==  
Line 45: Line 45:
{{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|Note no longer relevant, everything streams out fine now.}}


==See Also==
==See Also==
{{Client_world_functions}}
{{Client_world_functions}}

Revision as of 19:15, 21 December 2012

This template is no longer in use as it results in poor readability. This function is used to remove a world object.

[[{{{image}}}|link=|]] Tip: Post 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

bool removeWorldModel ( int modelID, float radius, float x, float y, float z [, int interior = 0 ] )

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 )

Returns

Returns true if the object was removed, false if invalid arguments were passed.

Requirements

This template will be deleted.

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,20000 do
    removeWorldModel(i,10,2494,-1696,17)
end

Changelog

Version Description
1.3.1-9.04636 Added interior argument
1.3.1-9.04844 Note no longer relevant, everything streams out fine now.

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/RemoveWorldModel?oldid=34312"