Version: 2022.3
LanguageEnglish
  • C#

EdgeCollider2D.SetPoints

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

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> 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

Declaration

public bool SetPoints(List<Vector2> points);

Parameters

points A list of Vector2 used to set the points. This list must contain at least two points.

Returns

bool Returns true if the list contains two or more points and the points are correctly set. Returns false otherwise.

Description

Sets all the points that define a set of continuous edges.

If the provided points list contains less than two points then false is returned indicating the points were not set. Any points that are not valid such as them being NaN or Infinite are set to Vector2.zero.