RemoveWorldModel

From Multi Theft Auto: Wiki

Revision as of 22:00, 20 January 2012 by Ccw (Talk | contribs)

Jump to: navigation, search

Note: 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.

Developer Note

I would strongly advise 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 )

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.

Returns

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

Requirements

Minimum supported server 1.2.0-9.03618
Minimum supported client 1.2.0-9.03618
Note: Using this function requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.2.0-9.03618" client="1.2.0-9.03618" />

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

See Also

FROM VERSION 1.3.5 r6101 ONWARDS
FROM VERSION 1.3.5 r6101 ONWARDS