EditableMesh
Instance which allows for the runtime creation and manipulation of meshes.
| Memory category | Instances |
|---|
Member index 57
Removed member index 2
| History | Member | |
|---|---|---|
| 604 | Raycast(origin: Vector3, direction: Vector3): Tuple |
Description
EditableMesh changes the applied visual mesh when parented to a MeshPart, allowing for querying and modification of the mesh both in Studio and in experience.
An EditableMesh can be created from an existing mesh ID using AssetService:CreateEditableMeshAsync(), or a blank EditableMesh can be created with Instance.new(). It can then be displayed, modified, and its collision model updated. Not all of the steps are necessary; for example, you might want to create an EditableMesh just to raycast without ever displaying it.
An EditableMesh is displayed when it's parented to a MeshPart, but only the part's appearance changes while the collision model remains the same.
Stable Vertex/Face IDs
Many EditableMesh methods take vertex and face IDs. These are
represented as integers in Luau but they require some special handling. The
main difference is that IDs are stable and they remain the same even if other
parts of the mesh change. For example, if an EditableMesh has five
vertices {1, 2, 3, 4, 5} and you remove vertex 4, the new vertices will be
{1, 2, 3, 5}.
Note that the IDs are not guaranteed to be in order and there may be holes in the numbering, so when iterating through vertices or faces, you should iterate through the table returned by GetVertices() or GetTriangles().
Winding
Mesh faces have a front side and a back side. When drawing meshes, only the
front of the faces are drawn by default, although you can change this by
setting the mesh' DoubleSided property to true.
The order of the vertices around the face determines whether you are looking at the front or the back. The front of the face is visible when the vertices go counterclockwise around it.
Limitations
EditableMesh currently has a limit of 60,000 vertices and 20,000 triangles. Attempting to add too many vertices or triangles will cause an error.
History 143
- 640 Add Triangulate
- 640 Change Tags of SetVertexNormal from [] to [Deprecated]
- 640 Change Tags of SetVertexColorAlpha from [] to [Deprecated]
- 640 Change Tags of SetVertexColor from [] to [Deprecated]
- 640 Change Parameters of SetUV from (vertexId: int64, uv: Vector2) to (uvId: int64, uv: Vector2)
- 640 Add SetNormal
- 640 Add SetFaceVertices
- 640 Add SetFaceUVs
- 640 Add SetFaceNormals
- 640 Add SetFaceColors
- 640 Add SetColorAlpha
- 640 Add SetColor
- 640 Add ResetNormal
- 640 Change Tags of RemoveVertex from [] to [Deprecated]
- 640 Add RemoveUnused
- 640 Change Tags of RemoveTriangle from [] to [Deprecated]
- 640 Add RemoveFace
- 640 Add MergeVertices
- 640 Add IdDebugString
- 640 Add GetVerticesWithAttribute
- 640 Change Tags of GetVertexNormal from [] to [Deprecated]
- 640 Change Tags of GetVertexColorAlpha from [] to [Deprecated]
- 640 Change Tags of GetVertexColor from [] to [Deprecated]
- 640 Add GetUVs
- 640 Change Parameters of GetUV from (vertexId: int64) to (uvId: int64)
- 640 Change ReturnType of GetUV from Vector2 to Vector2?
- 640 Change Tags of GetTriangles from [] to [Deprecated]
- 640 Change Tags of GetTriangleVertices from [] to [Deprecated]
- 640 Add GetNormals
- 640 Add GetNormal
- 640 Add GetFacesWithAttribute
- 640 Add GetFaces
- 640 Add GetFaceVertices
- 640 Add GetFaceUVs
- 640 Add GetFaceNormals
- 640 Add GetFaceColors
- 640 Add GetColors
- 640 Add GetColorAlpha
- 640 Add GetColor
- 640 Change Tags of GetAdjacentTriangles from [] to [Deprecated]
- 640 Add GetAdjacentFaces
- 640 Add AddUV
- 640 Add AddNormal
- 640 Add AddColor
- 636 Add
- 630 Change Tags of from [Hidden, NotReplicated, NotScriptable] to [Hidden, NotScriptable]
- 630 Change Tags of EditableMesh from [NotReplicated] to []
- 624 Add SkinningEnabled
- 619 Change Parameters of CreateMeshPartAsync from (collisionFidelity: CollisionFidelity) to (options: Dictionary = nil)
- 607 Remove
- 604 Change Parameters of SetVertexNormal from (vertexId: int, vnormal: Vector3) to (vertexId: int64, vnormal: Vector3)
- 604 Change Parameters of SetVertexColorAlpha from (vertexId: int, alpha: float) to (vertexId: int64, alpha: float)
- 604 Change Parameters of SetVertexColor from (vertexId: int, color: Color3) to (vertexId: int64, color: Color3)
- 604 Change Parameters of SetUV from (vertexId: int, uv: Vector2) to (vertexId: int64, uv: Vector2)
- 604 Change Parameters of SetPosition from (vertexId: int, p: Vector3) to (vertexId: int64, p: Vector3)
- 604 Change Parameters of RemoveVertex from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of RemoveTriangle from (triangleId: int) to (triangleId: int64)
- 604 Add RaycastLocal
- 604 Remove Raycast
- 604 Change Parameters of GetVertexNormal from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetVertexColorAlpha from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetVertexColor from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetUV from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetTriangleVertices from (triangleId: int) to (triangleId: int64)
- 604 Change Parameters of GetPosition from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetAdjacentVertices from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetAdjacentTriangles from (triangleId: int) to (triangleId: int64)
- 604 Change ReturnType of FindClosestVertex from int to int64
- 604 Change ReturnType of AddVertex from int to int64
- 604 Change ReturnType of AddTriangle from int to int64
- 604 Change Parameters of AddTriangle from (vertexId0: int, vertexId1: int, vertexId2: int) to (vertexId0: int64, vertexId1: int64, vertexId2: int64)
- 604 Change Tags of EditableMesh from [] to [NotReplicated]
- 603 Change Parameters of SetVertexNormal from (vertexId: int64, vnormal: Vector3) to (vertexId: int, vnormal: Vector3)
- 603 Change Parameters of SetVertexColorAlpha from (vertexId: int64, alpha: float) to (vertexId: int, alpha: float)
- 603 Change Parameters of SetVertexColor from (vertexId: int64, color: Color3) to (vertexId: int, color: Color3)
- 603 Change Parameters of SetUV from (vertexId: int64, uv: Vector2) to (vertexId: int, uv: Vector2)
- 603 Change Parameters of SetPosition from (vertexId: int64, p: Vector3) to (vertexId: int, p: Vector3)
- 603 Change Parameters of RemoveVertex from (vertexId: int64) to (vertexId: int)
- 603 Change Parameters of RemoveTriangle from (triangleId: int64) to (triangleId: int)
- 603 Remove RaycastLocal
- 603 Add Raycast
- 603 Change Parameters of GetVertexNormal from (vertexId: int64) to (vertexId: int)
- 603 Change Parameters of GetVertexColorAlpha from (vertexId: int64) to (vertexId: int)
- 603 Change Parameters of GetVertexColor from (vertexId: int64) to (vertexId: int)
- 603 Change Parameters of GetUV from (vertexId: int64) to (vertexId: int)
- 603 Change Parameters of GetTriangleVertices from (triangleId: int64) to (triangleId: int)
- 603 Change Parameters of GetPosition from (vertexId: int64) to (vertexId: int)
- 603 Change Parameters of GetAdjacentVertices from (vertexId: int64) to (vertexId: int)
- 603 Change Parameters of GetAdjacentTriangles from (triangleId: int64) to (triangleId: int)
- 603 Change ReturnType of FindClosestVertex from int64 to int
- 603 Change ReturnType of AddVertex from int64 to int
- 603 Change ReturnType of AddTriangle from int64 to int
- 603 Change Parameters of AddTriangle from (vertexId0: int64, vertexId1: int64, vertexId2: int64) to (vertexId0: int, vertexId1: int, vertexId2: int)
- 603 Change Tags of EditableMesh from [NotReplicated] to []
- 604 Change Parameters of SetVertexNormal from (vertexId: int, vnormal: Vector3) to (vertexId: int64, vnormal: Vector3)
- 604 Change Parameters of SetVertexColorAlpha from (vertexId: int, alpha: float) to (vertexId: int64, alpha: float)
- 604 Change Parameters of SetVertexColor from (vertexId: int, color: Color3) to (vertexId: int64, color: Color3)
- 604 Change Parameters of SetUV from (vertexId: int, uv: Vector2) to (vertexId: int64, uv: Vector2)
- 604 Change Parameters of SetPosition from (vertexId: int, p: Vector3) to (vertexId: int64, p: Vector3)
- 604 Change Parameters of RemoveVertex from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of RemoveTriangle from (triangleId: int) to (triangleId: int64)
- 604 Add RaycastLocal
- 604 Remove Raycast
- 604 Change Parameters of GetVertexNormal from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetVertexColorAlpha from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetVertexColor from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetUV from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetTriangleVertices from (triangleId: int) to (triangleId: int64)
- 604 Change Parameters of GetPosition from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetAdjacentVertices from (vertexId: int) to (vertexId: int64)
- 604 Change Parameters of GetAdjacentTriangles from (triangleId: int) to (triangleId: int64)
- 604 Change ReturnType of FindClosestVertex from int to int64
- 604 Change ReturnType of AddVertex from int to int64
- 604 Change ReturnType of AddTriangle from int to int64
- 604 Change Parameters of AddTriangle from (vertexId0: int, vertexId1: int, vertexId2: int) to (vertexId0: int64, vertexId1: int64, vertexId2: int64)
- 604 Change Tags of EditableMesh from [] to [NotReplicated]
- 602 Add SetVertexNormal
- 602 Add SetVertexColorAlpha
- 602 Add SetVertexColor
- 602 Add SetUV
- 602 Add SetPosition
- 602 Add RemoveVertex
- 602 Add RemoveTriangle
- 602 Add Raycast
- 602 Add GetVertices
- 602 Add GetVertexNormal
- 602 Add GetVertexColorAlpha
- 602 Add GetVertexColor
- 602 Add GetUV
- 602 Add GetTriangles
- 602 Add GetTriangleVertices
- 602 Add GetPosition
- 602 Add GetAdjacentVertices
- 602 Add GetAdjacentTriangles
- 602 Add FindVerticesWithinSphere
- 602 Add FindClosestVertex
- 602 Add FindClosestPointOnSurface
- 602 Add CreateMeshPartAsync
- 602 Add AddVertex
- 602 Add AddTriangle
- 602 Add
- 602 Add
- 602 Add EditableMesh
Members 57
AddColor
| Parameters (2) | ||
|---|---|---|
| color | Color3 | |
| alpha | float | |
| Returns (1) | ||
| int64 | ||
| Thread safety | Unsafe |
|---|
AddNormal
| Parameters (1) | ||
|---|---|---|
| normal | Vector3? | |
| Returns (1) | ||
| int64 | ||
| Thread safety | Unsafe |
|---|
AddTriangle
| Parameters (3) | ||
|---|---|---|
| vertexId0 | int64 | |
| vertexId1 | int64 | |
| vertexId2 | int64 | |
| Returns (1) | ||
| int64 | ||
Adds a new triangle to the mesh and returns a stable triangle ID.
| Thread safety | Unsafe |
|---|
History 7
- 604 Change ReturnType of AddTriangle from int to int64
- 604 Change Parameters of AddTriangle from (vertexId0: int, vertexId1: int, vertexId2: int) to (vertexId0: int64, vertexId1: int64, vertexId2: int64)
- 603 Change ReturnType of AddTriangle from int64 to int
- 603 Change Parameters of AddTriangle from (vertexId0: int64, vertexId1: int64, vertexId2: int64) to (vertexId0: int, vertexId1: int, vertexId2: int)
- 604 Change ReturnType of AddTriangle from int to int64
- 604 Change Parameters of AddTriangle from (vertexId0: int, vertexId1: int, vertexId2: int) to (vertexId0: int64, vertexId1: int64, vertexId2: int64)
- 602 Add AddTriangle
AddUV
| Parameters (1) | ||
|---|---|---|
| uv | Vector2 | |
| Returns (1) | ||
| int64 | ||
| Thread safety | Unsafe |
|---|
AddVertex
| Parameters (1) | ||
|---|---|---|
| p | Vector3 | |
| Returns (1) | ||
| int64 | ||
Adds a new vertex to the geometry and returns a stable vertex ID.
| Thread safety | Unsafe |
|---|
CreateMeshPartAsync
| Parameters (1) | Default | |
|---|---|---|
| options | Dictionary | nil |
| Returns (1) | ||
| MeshPart | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 619 Change Parameters of CreateMeshPartAsync from (collisionFidelity: CollisionFidelity) to (options: Dictionary = nil)
- 602 Add CreateMeshPartAsync
FindClosestPointOnSurface
| Parameters (1) | ||
|---|---|---|
| point | Vector3 | |
| Returns (1) | ||
| Tuple | ||
Finds the closest point on the mesh's surface. Returns the triangle ID, point on the mesh in local object space, and the barycentric coordinate of the position within the triangle. See RaycastLocal() for more information on barycentric coordinates.
| Thread safety | Unsafe |
|---|
History 1
FindClosestVertex
| Parameters (1) | ||
|---|---|---|
| toThisPoint | Vector3 | |
| Returns (1) | ||
| int64 | ||
Finds the closest vertex to a specific point in space and returns a stable vertex ID.
| Thread safety | Unsafe |
|---|
History 4
- 604 Change ReturnType of FindClosestVertex from int to int64
- 603 Change ReturnType of FindClosestVertex from int64 to int
- 604 Change ReturnType of FindClosestVertex from int to int64
- 602 Add FindClosestVertex
FindVerticesWithinSphere
| Parameters (2) | ||
|---|---|---|
| center | Vector3 | |
| radius | float | |
| Returns (1) | ||
| Array | ||
Finds all vertices within a specific sphere and returns a list of stable vertex IDs.
| Thread safety | Unsafe |
|---|
History 1
GetAdjacentFaces
| Parameters (1) | ||
|---|---|---|
| faceId | int64 | |
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add GetAdjacentFaces
GetAdjacentTriangles
| Parameters (1) | ||
|---|---|---|
| triangleId | int64 | |
| Returns (1) | ||
| Array | ||
Given a stable triangle ID, returns a list of adjacent triangles.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of GetAdjacentTriangles from [] to [Deprecated]
- 604 Change Parameters of GetAdjacentTriangles from (triangleId: int) to (triangleId: int64)
- 603 Change Parameters of GetAdjacentTriangles from (triangleId: int64) to (triangleId: int)
- 604 Change Parameters of GetAdjacentTriangles from (triangleId: int) to (triangleId: int64)
- 602 Add GetAdjacentTriangles
GetAdjacentVertices
| Parameters (1) | ||
|---|---|---|
| vertexId | int64 | |
| Returns (1) | ||
| Array | ||
Given a stable vertex ID, returns a list of adjacent vertices.
| Thread safety | Unsafe |
|---|
History 4
- 604 Change Parameters of GetAdjacentVertices from (vertexId: int) to (vertexId: int64)
- 603 Change Parameters of GetAdjacentVertices from (vertexId: int64) to (vertexId: int)
- 604 Change Parameters of GetAdjacentVertices from (vertexId: int) to (vertexId: int64)
- 602 Add GetAdjacentVertices
GetColor
| Parameters (1) | ||
|---|---|---|
| colorId | int64 | |
| Returns (1) | ||
| Color3? | ||
| Thread safety | Unsafe |
|---|
GetColorAlpha
| Parameters (1) | ||
|---|---|---|
| colorId | int64 | |
| Returns (1) | ||
| float? | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add GetColorAlpha
GetColors
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
GetFaceColors
| Parameters (1) | ||
|---|---|---|
| faceId | int64 | |
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add GetFaceColors
GetFaceNormals
| Parameters (1) | ||
|---|---|---|
| faceId | int64 | |
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add GetFaceNormals
GetFaceUVs
| Parameters (1) | ||
|---|---|---|
| faceId | int64 | |
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add GetFaceUVs
GetFaceVertices
| Parameters (1) | ||
|---|---|---|
| faceId | int64 | |
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add GetFaceVertices
GetFaces
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
GetFacesWithAttribute
| Parameters (1) | ||
|---|---|---|
| id | int64 | |
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 1
GetNormal
| Parameters (1) | ||
|---|---|---|
| normalId | int64 | |
| Returns (1) | ||
| Vector3? | ||
| Thread safety | Unsafe |
|---|
GetNormals
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add GetNormals
GetPosition
| Parameters (1) | ||
|---|---|---|
| vertexId | int64 | |
| Returns (1) | ||
| Vector3 | ||
Gets the position of a vertex in the mesh's local object space.
| Thread safety | Unsafe |
|---|
History 4
- 604 Change Parameters of GetPosition from (vertexId: int) to (vertexId: int64)
- 603 Change Parameters of GetPosition from (vertexId: int64) to (vertexId: int)
- 604 Change Parameters of GetPosition from (vertexId: int) to (vertexId: int64)
- 602 Add GetPosition
GetTriangleVertices
| Parameters (1) | ||
|---|---|---|
| triangleId | int64 | |
| Returns (1) | ||
| Tuple | ||
Returns a triangle's three vertex IDs.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of GetTriangleVertices from [] to [Deprecated]
- 604 Change Parameters of GetTriangleVertices from (triangleId: int) to (triangleId: int64)
- 603 Change Parameters of GetTriangleVertices from (triangleId: int64) to (triangleId: int)
- 604 Change Parameters of GetTriangleVertices from (triangleId: int) to (triangleId: int64)
- 602 Add GetTriangleVertices
GetTriangles
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
Returns all triangles of the mesh as a list of stable triangle IDs.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 2
- 640 Change Tags of GetTriangles from [] to [Deprecated]
- 602 Add GetTriangles
GetUV
| Parameters (1) | ||
|---|---|---|
| uvId | int64 | |
| Returns (1) | ||
| Vector2? | ||
Returns UV coordinates at the given vertex.
| Thread safety | Unsafe |
|---|
History 6
- 640 Change Parameters of GetUV from (vertexId: int64) to (uvId: int64)
- 640 Change ReturnType of GetUV from Vector2 to Vector2?
- 604 Change Parameters of GetUV from (vertexId: int) to (vertexId: int64)
- 603 Change Parameters of GetUV from (vertexId: int64) to (vertexId: int)
- 604 Change Parameters of GetUV from (vertexId: int) to (vertexId: int64)
- 602 Add GetUV
GetUVs
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
GetVertexColor
| Parameters (1) | ||
|---|---|---|
| vertexId | int64 | |
| Returns (1) | ||
| Color3 | ||
Returns the color at the given vertex.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of GetVertexColor from [] to [Deprecated]
- 604 Change Parameters of GetVertexColor from (vertexId: int) to (vertexId: int64)
- 603 Change Parameters of GetVertexColor from (vertexId: int64) to (vertexId: int)
- 604 Change Parameters of GetVertexColor from (vertexId: int) to (vertexId: int64)
- 602 Add GetVertexColor
GetVertexColorAlpha
| Parameters (1) | ||
|---|---|---|
| vertexId | int64 | |
| Returns (1) | ||
| float | ||
Returns the color alpha (transparency) at the given vertex.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of GetVertexColorAlpha from [] to [Deprecated]
- 604 Change Parameters of GetVertexColorAlpha from (vertexId: int) to (vertexId: int64)
- 603 Change Parameters of GetVertexColorAlpha from (vertexId: int64) to (vertexId: int)
- 604 Change Parameters of GetVertexColorAlpha from (vertexId: int) to (vertexId: int64)
- 602 Add GetVertexColorAlpha
GetVertexNormal
| Parameters (1) | ||
|---|---|---|
| vertexId | int64 | |
| Returns (1) | ||
| Vector3 | ||
Returns the normal at the given vertex.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of GetVertexNormal from [] to [Deprecated]
- 604 Change Parameters of GetVertexNormal from (vertexId: int) to (vertexId: int64)
- 603 Change Parameters of GetVertexNormal from (vertexId: int64) to (vertexId: int)
- 604 Change Parameters of GetVertexNormal from (vertexId: int) to (vertexId: int64)
- 602 Add GetVertexNormal
GetVertices
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
Returns all vertices as a list of stable vertex IDs.
| Thread safety | Unsafe |
|---|
History 1
- 602 Add GetVertices
GetVerticesWithAttribute
| Parameters (1) | ||
|---|---|---|
| id | int64 | |
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 1
IdDebugString
| Parameters (1) | ||
|---|---|---|
| id | int64 | |
| Returns (1) | ||
| string | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add IdDebugString
MergeVertices
| Parameters (1) | ||
|---|---|---|
| mergeTolerance | float | |
| Returns (1) | ||
| Map | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add MergeVertices
RaycastLocal
| Parameters (2) | ||
|---|---|---|
| origin | Vector3 | |
| direction | Vector3 | |
| Returns (1) | ||
| Tuple | ||
Casts a ray and returns a point of intersection, triangle ID, and barycentric coordinates. The inputs and outputs of this method are in the mesh's local object space.
A barycentric coordinate is a way of specifying a point within a triangle as a weighted combination of the 3 vertices of the triangle. This is useful as a general way of blending vertex attributes. See this method's code sample as an illustration.
| Thread safety | Unsafe |
|---|
History 3
- 604 Add RaycastLocal
- 603 Remove RaycastLocal
- 604 Add RaycastLocal
RemoveFace
| Parameters (1) | ||
|---|---|---|
| faceId | int64 | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add RemoveFace
RemoveTriangle
| Parameters (1) | ||
|---|---|---|
| triangleId | int64 | |
| Returns (1) | ||
| null | ||
Removes a triangle using its stable triangle ID.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of RemoveTriangle from [] to [Deprecated]
- 604 Change Parameters of RemoveTriangle from (triangleId: int) to (triangleId: int64)
- 603 Change Parameters of RemoveTriangle from (triangleId: int64) to (triangleId: int)
- 604 Change Parameters of RemoveTriangle from (triangleId: int) to (triangleId: int64)
- 602 Add RemoveTriangle
RemoveUnused
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add RemoveUnused
RemoveVertex
| Parameters (1) | ||
|---|---|---|
| vertexId | int64 | |
| Returns (1) | ||
| null | ||
Removes a vertex using its stable vertex ID.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of RemoveVertex from [] to [Deprecated]
- 604 Change Parameters of RemoveVertex from (vertexId: int) to (vertexId: int64)
- 603 Change Parameters of RemoveVertex from (vertexId: int64) to (vertexId: int)
- 604 Change Parameters of RemoveVertex from (vertexId: int) to (vertexId: int64)
- 602 Add RemoveVertex
ResetNormal
| Parameters (1) | ||
|---|---|---|
| normalId | int64 | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add ResetNormal
SetColor
| Parameters (2) | ||
|---|---|---|
| colorId | int64 | |
| color | Color3 | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
SetColorAlpha
| Parameters (2) | ||
|---|---|---|
| colorId | int64 | |
| alpha | float | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add SetColorAlpha
SetFaceColors
| Parameters (2) | ||
|---|---|---|
| faceId | int64 | |
| ids | Array | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add SetFaceColors
SetFaceNormals
| Parameters (2) | ||
|---|---|---|
| faceId | int64 | |
| ids | Array | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add SetFaceNormals
SetFaceUVs
| Parameters (2) | ||
|---|---|---|
| faceId | int64 | |
| ids | Array | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add SetFaceUVs
SetFaceVertices
| Parameters (2) | ||
|---|---|---|
| faceId | int64 | |
| ids | Array | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add SetFaceVertices
SetNormal
| Parameters (2) | ||
|---|---|---|
| normalId | int64 | |
| normal | Vector3 | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
SetPosition
| Parameters (2) | ||
|---|---|---|
| vertexId | int64 | |
| p | Vector3 | |
| Returns (1) | ||
| null | ||
Sets a vertex position in the mesh's local object space.
| Thread safety | Unsafe |
|---|
History 4
- 604 Change Parameters of SetPosition from (vertexId: int, p: Vector3) to (vertexId: int64, p: Vector3)
- 603 Change Parameters of SetPosition from (vertexId: int64, p: Vector3) to (vertexId: int, p: Vector3)
- 604 Change Parameters of SetPosition from (vertexId: int, p: Vector3) to (vertexId: int64, p: Vector3)
- 602 Add SetPosition
SetUV
| Parameters (2) | ||
|---|---|---|
| uvId | int64 | |
| uv | Vector2 | |
| Returns (1) | ||
| null | ||
Sets UV coordinates for a vertex.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Parameters of SetUV from (vertexId: int64, uv: Vector2) to (uvId: int64, uv: Vector2)
- 604 Change Parameters of SetUV from (vertexId: int, uv: Vector2) to (vertexId: int64, uv: Vector2)
- 603 Change Parameters of SetUV from (vertexId: int64, uv: Vector2) to (vertexId: int, uv: Vector2)
- 604 Change Parameters of SetUV from (vertexId: int, uv: Vector2) to (vertexId: int64, uv: Vector2)
- 602 Add SetUV
SetVertexColor
| Parameters (2) | ||
|---|---|---|
| vertexId | int64 | |
| color | Color3 | |
| Returns (1) | ||
| null | ||
Sets the color for a vertex.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of SetVertexColor from [] to [Deprecated]
- 604 Change Parameters of SetVertexColor from (vertexId: int, color: Color3) to (vertexId: int64, color: Color3)
- 603 Change Parameters of SetVertexColor from (vertexId: int64, color: Color3) to (vertexId: int, color: Color3)
- 604 Change Parameters of SetVertexColor from (vertexId: int, color: Color3) to (vertexId: int64, color: Color3)
- 602 Add SetVertexColor
SetVertexColorAlpha
| Parameters (2) | ||
|---|---|---|
| vertexId | int64 | |
| alpha | float | |
| Returns (1) | ||
| null | ||
Sets the color alpha (transparency) for a vertex.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of SetVertexColorAlpha from [] to [Deprecated]
- 604 Change Parameters of SetVertexColorAlpha from (vertexId: int, alpha: float) to (vertexId: int64, alpha: float)
- 603 Change Parameters of SetVertexColorAlpha from (vertexId: int64, alpha: float) to (vertexId: int, alpha: float)
- 604 Change Parameters of SetVertexColorAlpha from (vertexId: int, alpha: float) to (vertexId: int64, alpha: float)
- 602 Add SetVertexColorAlpha
SetVertexNormal
| Parameters (2) | ||
|---|---|---|
| vertexId | int64 | |
| vnormal | Vector3 | |
| Returns (1) | ||
| null | ||
Sets the normal for a vertex.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 5
- 640 Change Tags of SetVertexNormal from [] to [Deprecated]
- 604 Change Parameters of SetVertexNormal from (vertexId: int, vnormal: Vector3) to (vertexId: int64, vnormal: Vector3)
- 603 Change Parameters of SetVertexNormal from (vertexId: int64, vnormal: Vector3) to (vertexId: int, vnormal: Vector3)
- 604 Change Parameters of SetVertexNormal from (vertexId: int, vnormal: Vector3) to (vertexId: int64, vnormal: Vector3)
- 602 Add SetVertexNormal
SkinningEnabled
| Type | Default | |
|---|---|---|
| bool | false | |
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 1
- 624 Add SkinningEnabled
Triangulate
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
- 640 Add Triangulate