CreateObject: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''modelId:''' | *'''modelId:''' A whole integer specifying the GTA:SA 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. | ||
}} | }} | ||
| Line 30: | Line 30: | ||
This example creates an object when the resource starts: | This example creates an object when the resource starts: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function | function loadMapObjects() | ||
-- create an object at a specified position with a specified rotation | -- create an object at a specified position with a specified rotation | ||
createObject(1337, 5540.6654, 1020.55122, 1240.545, 90, 0, 0) | createObject(1337, 5540.6654, 1020.55122, 1240.545, 90, 0, 0) | ||
end | end | ||
addEventHandler("onResourceStart", resourceRoot, | addEventHandler("onResourceStart", resourceRoot, loadMapObjects) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
| Line 42: | Line 42: | ||
<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: | ||
function createObjectCommand( thePlayer, commandName ) | function createObjectCommand(thePlayer, commandName) | ||
if ( thePlayer ) then | if (thePlayer) then | ||
local x, y, z = getElementPosition ( thePlayer ) | local x, y, z = getElementPosition(thePlayer) | ||
-- create a | -- 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 object 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 | ||
outputConsole ( "Failed to create the object.", thePlayer ) | outputConsole("Failed to create the object.", thePlayer) | ||
end | end | ||
end | end | ||
end | end | ||
addCommandHandler ( "createObject", createObjectCommand ) | addCommandHandler("createObject", createObjectCommand) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
Revision as of 13:57, 2 February 2021
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-only Example 1This example creates an object when the resource starts:
function loadMapObjects()
-- 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, loadMapObjects)
Click to collapse [-]
Server-only Example 2This 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)
-- 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