CreateObject: Difference between revisions

Revision as of 11:11, 14 October 2024

Creates an object element at a given position and rotation.

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

[[{{{image}}}\|link=\|]]	Note: The alternative createBuilding function allows you to create objects that are non-dynamic. This createObject function can also create non-dynamic objects, but for optimization reasons it is recommended to spawn Buildings when creating static objects in the Dimension 0 (because they don't use the MTA object-streaming system).

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. See Object IDs for a list of model IDs.
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. See setLowLODElement for linking a LOD object.

Returns

Returns the object element if the creation was successful, false otherwise.

Example

Click to collapse [-]

How to automatically perform object/building creation

This example shows you how to easily verify if any object model ID is non-dynamic, so it can be used with the createBuilding function, as long as it's outside within the map boundaries. This script will only work CLIENTSIDE due to createBuilding.

function createObjectOrBuilding(modelID, x, y, z, rx, ry, rz, interior, dimension)
    -- Dynamic object models will always have a physical properties group different than -1.
    local isNonDynamic = engineGetModelPhysicalPropertiesGroup(modelID) == -1
    -- Buildings can't be placed outside dimension 0
    local isNormalDimension = dimension == 0
    -- Buildings can't be placed outside regular map boundaries
    local isInsideMapLimits = x >= -3000 and x <= 3000 and y >= -3000 and y <= 3000

    local obj, bld
    if isNonDynamic and isNormalDimension  and isInsideMapLimits then
        bld = createBuilding(modelID, x, y, z, rx, ry, rz, interior)
        assert(bld, ("Failed to create building with model ID %d at %f, %f, %f in interior %d"):format(modelID, x, y, z, interior))
    else
        obj = createObject(modelID, x, y, z, rx, ry, rz, false)
        assert(obj, ("Failed to create object with model ID %d at %f, %f, %f"):format(modelID, x, y, z))
        setElementInterior(obj, interior)
        setElementDimension(obj, dimension)
    end
    return obj or bld
end

-- This would be your object's model ID
local modelID = 3556
-- This would be your object's position coordinates
local x, y, z = 0, 0, 69
-- This would be your object's rotation coordinates
local rx, ry, rz = 0, 0, 90
-- This would be your object's interior ID
local interior = 0
-- This would be your object's dimension ID
local dimension = 0

local success, element = pcall(createObjectOrBuilding, modelID, x, y, z, rx, ry, rz, interior, dimension)
if not success then
    outputDebugString(("Failed to create object or building: %s"):format(tostring(element)), 4, 255, 25, 25)
    return
end

-- OPTIONAL: Then you can apply additional properties, like so:
if getElementType(element) == "object" then
    setObjectScale(element, 1.69)
    setObjectBreakable(element, false)
end
setElementAlpha(element, 255)
setElementCollisionsEnabled(element, true)
setElementFrozen(element, false)

Click to collapse [-]

Server-only Example 1

This 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 2

This 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
         outputChatBox("Object created successfully.", thePlayer)
      else
         outputChatBox("Failed to create the object.", thePlayer)
      end
   end
end
addCommandHandler("createobject", createObjectCommand)

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{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]] [[element]] at a given position and rotation.
-Creates an object in the GTA world.
+{{Note|Dynamic objects do not automatically have physics applied to them. Use [[setElementVelocity]](object, 0, 0, 0) to fix this.}}
+{{Note|The alternative [[createBuilding]] function allows you to create objects that are non-dynamic. This [[createObject]] function can also create non-dynamic objects, but for optimization reasons '''it is recommended to spawn [[building|Buildings]] when creating static objects in the [[Dimension]] 0''' (because they don't use the MTA object-streaming system).}}
 ==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===
-*'''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===
+===Required Arguments===
+*'''modelId:''' A whole integer specifying the GTA:SA object model ID. See [[Object_IDs|Object IDs]] for a list of model IDs.
+*'''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===
 {{OptionalArg}}
-*'''rx:''' a floating point number representing the rotation about the X axis in degrees.
+*'''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.
+*'''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.
+*'''rz:''' A floating point number representing the rotation about the Z axis in degrees.
 {{New items|3.0120|1.2|
-*'''isLowLOD:''' a bool value specifying if the object will be low LOD. A low LOD object has no collision and a longer draw distance.
+*'''isLowLOD:''' A bool value specifying if the object will be low LOD. A low LOD object has no collision and a longer draw distance. See [[setLowLODElement]] for linking a LOD object.
 }}
 ===Returns===
-* The [[object]] element if creation was successful.
+* Returns the [[object]] element if the creation was successful, ''false'' otherwise.
-* ''false'' otherwise.
-==Example==
-<section name="Example1" class="server" show="true">
+==Example==
+{{ExampleCreateObjectOrBuilding}}
+<section name="Server-only Example 1" class="server" show="true">
 This example creates an object when the resource starts:
 <syntaxhighlight lang="lua">
-function mapLoad ( name )
+function loadMapObjects()
     -- 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
-addEventHandler ( "onResourceStart", resourceRoot, mapLoad )
+addEventHandler("onResourceStart", resourceRoot, loadMapObjects)
 </syntaxhighlight>
 </section>
+<section name="Server-only Example 2" class="server" show="true">
+This example creates an object near the player who write /createObject in the chat:
-<section name="Example2" class="server" show="true">
-This example creates an object near player who write createObject:
 <syntaxhighlight lang="lua">
 -- this function is called whenever someone types 'createObject' in the console:
-function consoleCreateObject ( thePlayer, commandName )
+function createObjectCommand(thePlayer, commandName)
-    if ( thePlayer ) then
+    if (thePlayer) then
-       local x, y, z = getElementPosition ( thePlayer ) -- get the player's position
+       local x, y, z = getElementPosition(thePlayer)
-       -- 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 )
+          outputChatBox("Object created successfully.", thePlayer)
        else
-          outputConsole ( "Failed to create Object", thePlayer )
+          outputChatBox("Failed to create the object.", thePlayer)
        end
     end
 end
-addCommandHandler ( "createObject", consoleCreateObject )
+addCommandHandler("createobject", createObjectCommand)
 </syntaxhighlight>
 </section>
@@ Line 62: / Line 62: @@
 ==See Also==
 {{Object functions}}
-[[de:createObject]]

CreateObject: Difference between revisions

Revision as of 11:11, 14 October 2024

Syntax

Required Arguments

Optional Arguments

Returns

Example

See Also

Navigation menu

Search