GetColShapeType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getColShapeType ( colshape shape )   
int getColShapeType ( colshape shape )   
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[colshape]]:getShapeType|shapeType|}}
{{OOP||[[colshape]]:getShapeType|shapeType|}}
Line 13: Line 13:


===Returns===
===Returns===
Returns a ''string'' containing the colshape type, ''false'' if invalid arguments were passed.
Returns ''false'' if invalid arguments were passed, or an [[int]]eger of the type of the colshape, which include:
*'''0:''' circle
*'''1:''' cuboid
*'''2:''' sphere
*'''3:''' rectangle
*'''4:''' polygon
*'''5:''' tube


==Example==
==Example==
Line 35: Line 41:
==See Also==
==See Also==
{{Collision_shape_functions}}
{{Collision_shape_functions}}
[[hu:getColShapeType]]

Latest revision as of 09:41, 22 June 2019

This function is used to retrieve the type of an colshape.

Syntax

int getColShapeType ( colshape shape )  

OOP Syntax Help! I don't understand this!

Method: colshape:getShapeType(...)
Variable: .shapeType


Required Arguments

  • shape: The colshape you wish to get the type of.

Returns

Returns false if invalid arguments were passed, or an integer of the type of the colshape, which include:

  • 0: circle
  • 1: cuboid
  • 2: sphere
  • 3: rectangle
  • 4: polygon
  • 5: tube

Example

This example outputs the type of all colshapes.

local circle = createColCircle(0, 0, 1)
local cubboid = createColCuboid(0, 0, 0, 0, 0, 0)
local sphere = createColSphere(0, 0, 0, 0)
local rectangle = createColRectangle(0, 0, 0, 0)
local polygon = createColPolygon(0, 0, 0, 0, 0, 0, 0, 0)
local tube = createColTube(0, 0, 0, 0, 0)

iprint("circle", getColShapeType(circle), circle:getShapeType(), circle.shapeType)
iprint("cubboid", getColShapeType(cubboid), cubboid:getShapeType(), cubboid.shapeType)
iprint("sphere", getColShapeType(sphere), sphere:getShapeType(), sphere.shapeType)
iprint("rectangle", getColShapeType(rectangle), rectangle:getShapeType(), rectangle.shapeType)
iprint("polygon", getColShapeType(polygon), polygon:getShapeType(), polygon.shapeType)
iprint("tube", getColShapeType(tube), tube:getShapeType(), tube.shapeType)

See Also