CreateObject: Difference between revisions
Jump to navigation
Jump to search
(OOP syntax added) |
mNo edit summary |
||
| Line 7: | Line 7: | ||
{{OOP||Object.create||}} | {{OOP||Object.create||}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''modelid:''' | *'''modelid:''' a whole integer specifying the GTASA object model ID. | ||
*'''x:''' | *'''x:''' a floating point number representing the X coordinate on the map. | ||
*'''y:''' | *'''y:''' a floating point number representing the Y coordinate on the map. | ||
*'''z:''' | *'''z:''' a floating point number representing the Z coordinate on the map. | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''rx:''' | *'''rx:''' a floating point number representing the rotation about the X axis in degrees. | ||
*'''ry:''' | *'''ry:''' a floating point number representing the rotation about the Y axis in degrees. | ||
*'''rz:''' | *'''rz:''' a floating point number representing the rotation about the Z axis in degrees. | ||
{{New items|3.0120|1.2| | {{New items|3.0120|1.2| | ||
*'''isLowLOD:''' | *'''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== | ==Example== | ||
Revision as of 22:45, 4 October 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
- 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 )