RemoveWorldModel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool removeWorldModel ( int modelID, float radius, float x, float y, float z )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool removeWorldModel ( int modelID, float radius, float x, float y, float z [, int iInterior = -1 ] )</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
Line 16: Line 16:
*'''y:''' A floating point number representing the Y 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.
*'''z:''' A floating point number representing the Z coordinate on the map.
{{New items|3.0132|1.3.2|
*'''iInterior:'''
}}


===Returns===
===Returns===
Line 38: Line 41:
end
end
</syntaxhighlight>
</syntaxhighlight>
==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04636|Added iInterior argument}}


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

Revision as of 13:30, 10 September 2012

This template is no longer in use as it results in poor readability. 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 [, int iInterior = -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.
  • iInterior:

Returns

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

Requirements

Minimum server version 1.2.0-9.03618
Minimum client version 1.2.0-9.03618

Note: Using this feature 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

Changelog

Version Description
1.3.1-9.04636 Added iInterior argument

See Also