π StaticMesh
A StaticMesh entity represents a Mesh which can be spawned in the world, can't move and is more optimized for using in decorating the world.
πAuthority
πͺInheritance
π§βπ»API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
Static Meshes are like Props, but with fewer interaction options. Static Meshes are aimed to offer better performance on spawning Static "objects" in the world than Props.
tip
Automatically all StaticMeshActors present in the Level will be loaded as a StaticMesh entity in the client side.
π Constructorsβ
Default Constructor
local my_staticmesh = StaticMesh(location, rotation, static_mesh_asset, collision_type?)
Type | Name | Default | Description |
---|---|---|---|
Vector | location | Required parameter | No description provided |
Rotator | rotation | Required parameter | No description provided |
StaticMesh Reference | static_mesh_asset | Required parameter | No description provided |
CollisionType | collision_type | CollisionType.Auto | No description provided |
πΏ Static Functionsβ
Inherited Entity Static Functions
π¦ Functionsβ
Inherited Entity Functions
Inherited Actor Functions
Inherited Paintable Functions
Returns | Name | Description | |
---|---|---|---|
StaticMesh Reference | GetMesh | Gets the Asset path mesh used | |
table | GetSocketTransform | Gets a Socket Transform in world space given a bone name | |
boolean | IsFromLevel | Gets if this StaticMesh is from the Level | |
SetMesh | Changes the mesh in runtime |
GetMesh
Gets the Asset path mesh used
β Returns StaticMesh Reference (asset path).
local ret = my_staticmesh:GetMesh()
See also SetMesh.
GetSocketTransform
Gets a Socket Transform in world space given a bone name
β Returns table (with this format).
local ret = my_staticmesh:GetSocketTransform(socket_name)
Type | Parameter | Default | Description |
---|---|---|---|
string | socket_name | Required parameter | No description provided |
IsFromLevel
Gets if this StaticMesh is from the Level
β Returns boolean (if this StaticMesh is from the level).
local ret = my_staticmesh:IsFromLevel()
SetMesh
Changes the mesh in runtime
my_staticmesh:SetMesh(static_mesh_asset)
Type | Parameter | Default | Description |
---|---|---|---|
StaticMesh Reference | static_mesh_asset | Required parameter | asset |
See also GetMesh.