RemoveWorldModel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "removeWorldModel ( modelID, radius, x, y, z )")
 
No edit summary
Line 1: Line 1:
removeWorldModel ( modelID, radius, x, y, z )
__NOTOC__
{{Client function|New items}}
This function is used to remove a world object.
 
==Syntax==
<syntaxhighlight lang="lua">bool removeWorldModel ( int modelID, float radius, float x, float y, float z )</syntaxhighlight>
 
===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==
{{Requirements|n/a|1.3|}}
 
==Example==
This example will removes buildings on BigEar.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
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
</syntaxhighlight>
</section>

Revision as of 01:15, 23 December 2011

This function is used to remove a world object.

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 server version n/a
Minimum client version 1.3

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 client="1.3" />

Example

This example will removes buildings on BigEar.

Click to collapse [-]
Client
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