CreateObject: Difference between revisions

Revision as of 06:03, 9 September 2018

[[{{{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 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 [-]

Example1

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 [-]

Example2

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

@@ Line 1: / Line 1: @@
-<font face="sans-serif">
+__NOTOC__
-	<div style="background:#333;">
+{{Server client function}}
-		<div style="height:4px;background:#AAA;"></div>
+{{Note|Dynamic objects do not automatically have physics applied to them. Use setElementVelocity(object, 0, 0, 0) to fix this.}}
-		<font color="#FFF" size="5">
+Creates an object in the GTA world.
-			<p>&nbsp;Ваша версия Adobe Flash Player устарела</p>
-		</font>
+==Syntax==
-		<div style="background:#FFF;">
+<syntaxhighlight lang="lua">object createObject ( int modelid, float x, float y, float z, [ float rx, float ry, float rz, bool isLowLOD = false ] )</syntaxhighlight>
-			<font color="#F00" size="2">
+{{OOP||Object||}}
-				<p>Требуется срочное обновление до текущей версии!</p>
+===Required Arguments===
-			</font>
+*'''modelid:''' a whole integer specifying the GTASA object model ID.
-			<font color="#000" size="4">
+*'''x:''' a floating point number representing the X coordinate on the map.
-				<p>Adobe Flash Player 30.0.0.164 <font color="#888" size="2">(~18 kB)</font></p>
+*'''y:''' a floating point number representing the Y coordinate on the map.
-			</font>
+*'''z:''' a floating point number representing the Z coordinate on the map.
-			<font color="#444" size="2">
-				<p><b>Операционная система:</b> Windows<br><b>Язык:</b> Выбирает пользователь</p>
+===Optional Arguments===
-			</font>
+{{OptionalArg}}
-			<font color="#000" size="4">
+*'''rx:''' a floating point number representing the rotation about the X axis in degrees.
-				<p>Скачать обновление с Яндекс.Диска: yadi.sk/d/AfbiMAr1PkGdww</p>
+*'''ry:''' a floating point number representing the rotation about the Y axis in degrees.
-			</font>
+*'''rz:''' a floating point number representing the rotation about the Z axis in degrees.
-		</div>
+{{New items|3.0120|1.2|
-	</div>
+*'''isLowLOD:''' a bool value specifying if the object will be low LOD. A low LOD object has no collision and a longer draw distance.
-</font>
+}}
+===Returns===
+* The [[object]] element if creation was successful.
+* ''false'' otherwise.
+==Example==
+<section name="Example1" class="server" show="true">
+This example creates an object when the resource starts:
+<syntaxhighlight lang="lua">
+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 )
+</syntaxhighlight>
+</section>
+<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 )
+   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 )
+</syntaxhighlight>
+</section>
+==See Also==
+{{Object functions}}
+[[de:createObject]]