CreateObject: Difference between revisions
Jump to navigation
Jump to search
(OOP syntax added) |
|||
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.create||}} | |||
===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 06:28, 12 July 2014
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.create(...)
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
Returns the object element if creation was successful, false otherwise.
Example
Click to collapse [-]
Example1This 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 [-]
Example2This 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 )