GetColShapeType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(typo)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Server client function}}
{{Server client function}}
__NOTOC__
__NOTOC__
{{New feature/item|3.0156|1.5.5|12251|This function is used to retrieve the type of an colshape.}}
{{New feature/item|3.0156|1.5.5|12286|This function is used to retrieve the type of an colshape.}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getColShapeType ( colshape theColShape )   
int getColShapeType ( colshape shape )   
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[colshape]]:getShapeType|shapeType|}}
{{OOP||[[colshape]]:getShapeType|shapeType|}}


===Required Arguments===  
===Required Arguments===  
*'''theColshape:''' The [[colshape]] you wish to get the type of.
*'''shape:''' The [[colshape]] you wish to get the type of.


===Returns===
===Returns===
Returns a ''string'' containing the colshapetype, ''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==
<section name="Shared" class="client" show="true">
This example outputs the type of all colshapes.
This example show type of every possible shape type.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local circle = createColCircle(0,0,1)
local circle = createColCircle(0, 0, 1)
local cubboid = createColCuboid(0,0,0,0,0,0)
local cubboid = createColCuboid(0, 0, 0, 0, 0, 0)
local sphere = createColSphere(0,0,0,0)
local sphere = createColSphere(0, 0, 0, 0)
local rectangle = createColRectangle(0,0,0,0)
local rectangle = createColRectangle(0, 0, 0, 0)
local polygon = createColPolygon(0,0,0,0,0,0,0,0)
local polygon = createColPolygon(0, 0, 0, 0, 0, 0, 0, 0)
local tube = createColTube(0,0,0,0,0)
local tube = createColTube(0, 0, 0, 0, 0)


iprint("circle",getColShapeType(circle), circle:getShapeType(), circle.shapeType)
iprint("circle", getColShapeType(circle), circle:getShapeType(), circle.shapeType)
iprint("cubboid",getColShapeType(cubboid), cubboid:getShapeType(), cubboid.shapeType)
iprint("cubboid", getColShapeType(cubboid), cubboid:getShapeType(), cubboid.shapeType)
iprint("sphere",getColShapeType(sphere), sphere:getShapeType(), sphere.shapeType)
iprint("sphere", getColShapeType(sphere), sphere:getShapeType(), sphere.shapeType)
iprint("rectangle",getColShapeType(rectangle), rectangle:getShapeType(), rectangle.shapeType)
iprint("rectangle", getColShapeType(rectangle), rectangle:getShapeType(), rectangle.shapeType)
iprint("polygon",getColShapeType(polygon), polygon:getShapeType(), polygon.shapeType)
iprint("polygon", getColShapeType(polygon), polygon:getShapeType(), polygon.shapeType)
iprint("tube",getColShapeType(tube), tube:getShapeType(), tube.shapeType)
iprint("tube", getColShapeType(tube), tube:getShapeType(), tube.shapeType)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Element 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

Retrieved from "https://wiki.multitheftauto.com/wiki/GetColShapeType?oldid=63058"