Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

PolygonCollider2D.CreatePrimitive

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function CreatePrimitive(sides: int, scale: Vector2 = Vector2.one, offset: Vector2 = Vector2.zero): void;
public void CreatePrimitive(int sides, Vector2 scale = Vector2.one, Vector2 offset = Vector2.zero);

Parameters

sidesThe number of sides in the polygon. This must be greater than two.
scaleThe X/Y scale of the polygon. These must be greater than zero.
offsetThe X/Y offset of the polygon.

Description

Creates as regular primitive polygon with the specified number of sides.