CreateObject

From Multi Theft Auto: Wiki
Revision as of 13:46, 2 February 2021 by Saint Laurent (talk | contribs)
Jump to navigation Jump to search

Creates an object in the GTA world.

[[{{{image}}}|link=|]] Note: Dynamic objects do not automatically have physics applied to them. Use setElementVelocity(object, 0, 0, 0) to fix this.

Syntax

object createObject ( int modelId, float x, float y, float z, [ float rx, float ry, float rz, bool isLowLOD = false ] )

OOP Syntax Help! I don't understand this!

Method: Object(...)


Required Arguments

  • modelId: a whole integer specifying the GTA:SA object model ID.
  • 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

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • rx: a floating point number representing the rotation about the X axis in degrees.
  • ry: a floating point number representing the rotation about the Y axis in degrees.
  • rz: a floating point number representing the rotation about the Z axis in degrees.
  • isLowLOD: a bool value specifying if the object will be low LOD. A low LOD object has no collision and a longer draw distance.

Returns

  • Returns the object element if the creation was successful, false otherwise.

Example

Click to collapse [-]
Server-only Example 1

This example creates an object when the resource starts:

function mapLoad(name)
   -- create an object at a specified position with a specified rotation
   createObject(1337, 5540.6654, 1020.55122, 1240.545, 90, 0, 0)
end
addEventHandler("onResourceStart", resourceRoot, mapLoad)
Click to collapse [-]
Server-only Example 2

This example creates an object near the player who write /createObject in the chat:

-- this function is called whenever someone types 'createObject' in the console:
function createObjectCommand( thePlayer, commandName )
   if ( thePlayer ) then
      local x, y, z = getElementPosition ( thePlayer ) -- get the player's position
      -- create a Object next to the player:
      local theObject = createObject ( 980, x + 2, y + 2, z, 0, 0, 0 )
      if ( theObject ) then -- check if the object was created successfully
         outputConsole ( "Object created successfully.", thePlayer )
      else
         outputConsole ( "Failed to create the object.", thePlayer )
      end
   end
end
addCommandHandler ( "createObject", createObjectCommand )

See Also