CreateObject: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (update oop syntax and update arrans msg)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server client function}}
{{Server client function}}
{{Note|Dynamic objects do not automatically have physics applied to them. Use setElementVelocity(object, 0, 0, 0) to fix this.}}
Creates an object in the GTA world.
Creates an object in the GTA world.
Note: Dynamic objects (objects that can be pushed) do not automatically have physics applied to them. Use setElementVelocity(object, 0, 0, 0) to fix this.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">object createObject ( int modelid, float x, float y, float z, [ float rx, float ry, float rz, bool isLowLOD = false ] )</syntaxhighlight>  
<syntaxhighlight lang="lua">object createObject ( int modelid, float x, float y, float z, [ float rx, float ry, float rz, bool isLowLOD = false ] )</syntaxhighlight>  
{{OOP||Object.create||}}
{{OOP||Object||}}
===Required Arguments===  
===Required Arguments===  
*'''modelid:''' a whole integer specifying the GTASA object model ID.
*'''modelid:''' a whole integer specifying the GTASA object model ID.

Revision as of 16:51, 23 November 2014

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

Creates an object in the GTA world.

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 GTASA 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

  • The object element if creation was successful.
  • false otherwise.

Example

Click to collapse [-]
Example1

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", getRootElement(), mapLoad )


Click to collapse [-]
Example2

This example creates an object near player who write createObject: 

-- this function is called whenever someone types 'createObject' in the console:
function consoleCreateObject ( 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 Obeject was created successfully
         outputConsole ( "Object created successfully", thePlayer )
      else
         outputConsole ( "Failed to create Object", thePlayer )
      end
   end
end
addCommandHandler ( "createObject", consoleCreateObject )

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/CreateObject?oldid=42987"