🏠 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
This class inherits from Base Actor Base Paintable .
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.
🏗️ Constructor
local my_staticmesh = StaticMesh(location?, rotation?, static_mesh_asset?, collision_type?)
| Type | Name | Default | Description |
|---|---|---|---|
| Vector | location | Vector(0, 0, 0) | |
| Rotator | rotation | Rotator(0, 0, 0) | |
| StaticMesh Reference | static_mesh_asset | | |
| CollisionType | collision_type | CollisionType.Normal |
🦠 Functions
Inherited Actor Functions
Base Actorscripting-reference/classes/base-classes/actor
| Returns | Name | Description | |
|---|---|---|---|
 | AddImpulse | Applies a force in world world to this Actor | |
| | AttachTo | Attaches this Actor to any other Actor, optionally at a specific bone | |
| | Destroy | Destroys this Actor | |
| | Detach | Detaches this Actor from AttachedTo Actor | |
| | SetCollision | Sets this Actor's collision type | |
| | SetForce | Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel | |
| | SetGravityEnabled | Sets whether gravity is enabled on this Actor | |
 | SetVisibility | Sets whether the actor is visible or not | |
 | SetHighlightEnabled | Sets whether the highlight is enabled on this Actor, and which highlight index to use | |
| | SetOutlineEnabled | Sets whether the outline is enabled on this Actor, and which outline index to use | |
| | SetLifeSpan | Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed. | |
| | SetLocation | Sets this Actor's location in the game world | |
| | SetRotation | Sets this Actor's rotation in the game world | |
| | SetRelativeLocation | Sets this Actor's relative location in local space (only if this actor is attached) | |
| | SetRelativeRotation | Sets this Actor's relative rotation in local space (only if this actor is attached) | |
| | SetScale | Sets this Actor's scale | |
 | SetNetworkAuthority | Sets the Player to have network authority over this Actor | |
| | SetValue | Sets a value in this Actor | |
| | TranslateTo | Smoothly moves this actor to a location over a certain time | |
| | RotateTo | Smoothly rotates this actor to an angle over a certain time | |
| | boolean | IsBeingDestroyed | Returns true if this Actor is being destroyed |
| | boolean | IsVisible | Returns true if this Actor is visible |
| | boolean | IsGravityEnabled | Returns true if gravity is enabled on this Actor |
| | boolean | IsInWater | Returns true if this Actor is in water |
| | boolean | IsNetworkDistributed | Returns true if this Actor is currently network distributed |
| | boolean | IsValid | Returns true if this Actor is valid (i.e. wasn't destroyed and points to a valid Actor) |
| | table of Base Actor | GetAttachedEntities | Gets all Actors attached to this Actor |
| | Base Actor or nil | GetAttachedTo | Gets the Actor this Actor is attached to |
| | table | GetBounds | Gets this Actor's bounds |
| | CollisionType | GetCollision | Gets this Actor's collision type |
| | number | GetID | Gets the universal network ID of this Actor (same on both client and server) |
| | Vector | GetLocation | Gets this Actor's location in the game world |
| | Rotator | GetRotation | Gets this Actor's angle in the game world |
| | Vector | GetForce | Gets this Actor's force (set by SetForce()) |
| | boolean | HasNetworkAuthority | Returns true if the local Player is currently the Network Authority of this Actor |
| | boolean | HasAuthority | Gets if this Actor was spawned by the client side |
| | Vector | GetScale | Gets this Actor's scale |
| | string | GetType | Gets the type of this Actor |
| | any | GetValue | Gets a value stored on this Actor at the given key. Please refer to Entity Values for more information |
| | Vector | GetVelocity | Gets this Actor's current velocity |
| | AddActorTag | Adds an Unreal Actor Tag to this Actor | |
| | RemoveActorTag | Removes an Unreal Actor Tag from this Actor | |
| | table of string | GetActorTags | Gets all Unreal Actor Tags on this Actor |
| | function | Subscribe | Subscribes to an Event |
| | Unsubscribe | Unsubscribes all callbacks from this Event in this Actor within this Package, or only the callback passed |
Inherited Paintable Functions
Base Paintablescripting-reference/classes/base-classes/paintable
| Returns | Name | Description | |
|---|---|---|---|
| | SetMaterial | Sets the material at the specified index of this Actor | |
| | SetMaterialFromCanvas | Sets the material at the specified index of this Actor to a Canvas object | |
| | SetMaterialFromSceneCapture | Sets the material at the specified index of this Actor to a SceneCapture object | |
| | SetMaterialFromWebUI | Sets the material at the specified index of this Actor to a WebUI object | |
| | ResetMaterial | Resets the material from the specified index to the original one | |
| | SetMaterialColorParameter | Sets a Color parameter in this Actor's material | |
| | SetMaterialScalarParameter | Sets a Scalar parameter in this Actor's material | |
| | SetMaterialTextureParameter | Sets a texture parameter in this Actor's material to an image on disk | |
| | SetMaterialVectorParameter | Sets a Vector parameter in this Actor's material | |
| | SetPhysicalMaterial | Overrides this Actor's Physical Material with a new one |
| Returns | Name | Description | |
|---|---|---|---|
| | StaticMesh Reference | GetMesh | Gets the Asset path mesh used |
| | boolean | IsFromLevel | Gets if this StaticMesh is from the Level |
GetMesh
Gets the Asset path mesh used
Returns StaticMesh Reference (asset path)
local ret = my_staticmesh:GetMesh()
IsFromLevel
Gets if this StaticMesh is from the Level
Returns boolean (if this StaticMesh is from the level)
local ret = my_staticmesh:IsFromLevel()
🚀 Events
Inherited Actor Events
Base Actorscripting-reference/classes/base-classes/actor
| Name | Description | |
|---|---|---|
| | Destroy | Triggered when an Actor is destroyed |
| | Spawn | Triggered when an Actor is spawned/created |
| | ValueChange | Triggered when an Actor has a value changed with :SetValue() |
| Name | Description | |
|---|---|---|
| | TakeDamage | Called when a StaticMesh takes Damage |
TakeDamage
Called when a StaticMesh takes Damage
StaticMesh.Subscribe("TakeDamage", function(self, damage, bone, type, from_direction, instigator, causer)
end)
| Type | Argument | Description |
|---|---|---|
| StaticMesh | self | The entity which triggered |
| number | damage | Damage amount |
| string | bone | Damaged bone |
| DamageType | type | Damage Type |
| Vector | from_direction | Direction of the damage relative to the damaged actor |
| Player | instigator | The player which caused the damage |
| any | causer | The object which caused the damage |