CreateObject: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Undo revision 59049 by Lizzalka (talk))
No edit summary
Line 5: Line 5:


==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||}}
{{OOP||Object||}}
===Required Arguments===  
===Required Arguments===  
*'''modelid:''' a whole integer specifying the GTASA object model ID.
*'''modelId:''' a whole integer specifying the GTA:SA object model ID.
*'''x:''' a floating point number representing the X coordinate on the map.
*'''x:''' a floating point number representing the X coordinate on the map.
*'''y:''' a floating point number representing the Y coordinate on the map.
*'''y:''' a floating point number representing the Y coordinate on the map.
Line 22: Line 22:
}}
}}
===Returns===
===Returns===
* The [[object]] element if creation was successful.
* Returns the [[object]] element if the creation was successful, ''false'' otherwise.
* ''false'' otherwise.


==Example==  
==Example==  


<section name="Example1" class="server" show="true">
<section name="Server Example 1" class="server" show="true">
This example creates an object when the resource starts:
This example creates an object when the resource starts:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 40: Line 39:




<section name="Example2" class="server" show="true">
<section name="Server Example 2" class="server" show="true">
This example creates an object near player who write createObject:
This example creates an object near player who write /createObject in the chat:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- this function is called whenever someone types 'createObject' in the console:
-- this function is called whenever someone types 'createObject' in the console:
Line 49: Line 48:
       -- create a Object next to the player:
       -- create a Object next to the player:
       local theObject = createObject ( 980, x + 2, y + 2, z, 0, 0, 0 )
       local theObject = createObject ( 980, x + 2, y + 2, z, 0, 0, 0 )
       if ( theObject ) then -- check if the Obeject was created successfully
       if ( theObject ) then -- check if the object was created successfully
         outputConsole ( "Object created successfully", thePlayer )
         outputConsole ( "Object created successfully", thePlayer )
       else
       else
Line 62: Line 61:
==See Also==
==See Also==
{{Object functions}}
{{Object functions}}
[[de:createObject]]

Revision as of 13:37, 2 February 2021

[[{{{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 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 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 Example 2

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

-- 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 object 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=68476"