Base Paintable
Base class for all Paintable entities. This class provides customization for materials, exposing common functions to allow you to set custom material parameters, including loading textures from disk.
๐ชBase Class
This is a Base Class. Base Classes are abstract definitions used to share common methods and events between related child classes, thus you cannot spawn it directly.
Classes that share methods and events from this Base Class: Billboard, Blueprint, Cable, Character, CharacterSimple, Decal, Grenade, InstancedStaticMesh, Melee, Prop, StaticMesh, Text3D, VehicleWheeled, VehicleWater, Weapon.
Classes that share methods and events from this Base Class: Billboard, Blueprint, Cable, Character, CharacterSimple, Decal, Grenade, InstancedStaticMesh, Melee, Prop, StaticMesh, Text3D, VehicleWheeled, VehicleWater, Weapon.
๐งโ๐ป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!
๐ฆ ย Functionsโ
| Returns | Name | Description | |
|---|---|---|---|
 | Color | GetMaterialColorParameter | Gets a Color parameter from this Actor's material |
| float | GetMaterialScalarParameter | Gets a Scalar parameter from this Actor's material |
| string | GetMaterialTextureParameter | Gets a Texture parameter from this Actor's material |
| Vector | GetMaterialVectorParameter | Gets a Vector parameter from this Actor's material |
| ResetMaterial | Resets the material from the specified index to the original one | |
| SetMaterial | Sets the material at the specified index of this Actor | |
| SetMaterialColorParameter | Sets a Color parameter in this Actor's material | |
 | 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 | |
| SetMaterialScalarParameter | Sets a Scalar parameter in this Actor's material | |
| SetMaterialTextureParameter | Sets a texture parameter in this Actor's material to an image | |
| SetMaterialVectorParameter | Sets a Vector parameter in this Actor's material | |
| SetPhysicalMaterial | Overrides this Actor's Physical Material with a new one |
GetMaterialColorParameter
โ
Gets a Color parameter from this Actor's material
local color = my_paintable:GetMaterialColorParameter(parameter_name, index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | parameter_name | Required parameter | The name of the material parameter |
| integer | index? | -1 | The material index to get |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to get the material parameter. Pass empty to get from main mesh only |
Returns
| Type | Description |
|---|---|
| Color | or nil if parameter was not found |
See also SetMaterialColorParameter.
GetMaterialScalarParameterโ
Gets a Scalar parameter from this Actor's material
local scalar = my_paintable:GetMaterialScalarParameter(parameter_name, index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | parameter_name | Required parameter | The name of the material parameter |
| integer | index? | -1 | The material index to get |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to get the material parameter. Pass empty to get from main mesh only |
Returns
| Type | Description |
|---|---|
| float | or nil if parameter was not found |
See also SetMaterialScalarParameter.
GetMaterialTextureParameterโ
Gets a Texture parameter from this Actor's material
local texture = my_paintable:GetMaterialTextureParameter(parameter_name, index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | parameter_name | Required parameter | The name of the material parameter |
| integer | index? | -1 | The material index to get |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to get the material parameter. Pass empty to get from main mesh only |
Returns
| Type | Description |
|---|---|
| string | or nil if parameter was not found |
See also SetMaterialTextureParameter.
GetMaterialVectorParameterโ
Gets a Vector parameter from this Actor's material
local vector = my_paintable:GetMaterialVectorParameter(parameter_name, index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | parameter_name | Required parameter | The name of the material parameter |
| integer | index? | -1 | The material index to get |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to get the material parameter. Pass empty to get from main mesh only |
Returns
| Type | Description |
|---|---|
| Vector | or nil if parameter was not found |
See also SetMaterialVectorParameter.
ResetMaterial
โ
Resets the material from the specified index to the original one
my_paintable:ResetMaterial(index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| integer | index? | -1 | The material index to apply (-1 means all indices) |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to reset the material. Pass empty to reset on main mesh only |
SetMaterial
โ
Sets the material at the specified index of this Actor
my_paintable:SetMaterial(material_path, index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Material Reference | material_path | Required parameter | The new Material to apply. Note: depending on the entity you are applying, the material needs to be configured to be "Used with Skeletal Mesh" or "Used with Particles", etc. in the material settings, otherwise it may not be applied correctly |
| integer | index? | -1 | The material index to apply (-1 means all indices) |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to apply the material. Pass empty to set on main mesh only |
SetMaterialColorParameterโ
Sets a Color parameter in this Actor's material
my_paintable:SetMaterialColorParameter(parameter_name, color, index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | parameter_name | Required parameter | The name of the material parameter |
| Color | color | Required parameter | The value to set |
| integer | index? | -1 | The material index to apply (-1 means all indices) |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to apply the material parameter. Pass empty to set on main mesh only |
See also GetMaterialColorParameter.
SetMaterialFromCanvasโ
Sets the material at the specified index of this Actor to a Canvas object
my_paintable:SetMaterialFromCanvas(canvas, index?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Canvas | canvas | Required parameter | The Canvas object to use as a material |
| integer | index? | -1 | The material index to apply (-1 means all indices) |
SetMaterialFromSceneCaptureโ
Sets the material at the specified index of this Actor to a SceneCapture object
my_paintable:SetMaterialFromSceneCapture(scene_capture, index?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| SceneCapture | scene_capture | Required parameter | The SceneCapture object to use as a material |
| integer | index? | -1 | The material index to apply (-1 means all indices) |
SetMaterialFromWebUIโ
Sets the material at the specified index of this Actor to a WebUI object
my_paintable:SetMaterialFromWebUI(webui, index?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| WebUI | webui | Required parameter | The WebUI object to use as a material |
| integer | index? | -1 | The material index to apply (-1 means all indices) |
SetMaterialScalarParameterโ
Sets a Scalar parameter in this Actor's material
my_paintable:SetMaterialScalarParameter(parameter_name, scalar, index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | parameter_name | Required parameter | The name of the material parameter |
| float | scalar | Required parameter | The value to set |
| integer | index? | -1 | The material index to apply (-1 means all indices) |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to apply the material parameter. Pass empty to set on main mesh only |
See also GetMaterialScalarParameter.
SetMaterialTextureParameterโ
Sets a texture parameter in this Actor's material to an image
my_paintable:SetMaterialTextureParameter(parameter_name, texture_path, index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | parameter_name | Required parameter | The name of the material parameter |
| Image Path | texture_path | Required parameter | The path to texture, a url or a base64 |
| integer | index? | -1 | The material index to apply (-1 means all indices) |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to apply the material parameter. Pass empty to set on main mesh only |
See also GetMaterialTextureParameter.
SetMaterialVectorParameterโ
Sets a Vector parameter in this Actor's material
my_paintable:SetMaterialVectorParameter(parameter_name, vector, index?, attachable_id?)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | parameter_name | Required parameter | The name of the material parameter |
| Vector | vector | Required parameter | The value to set |
| integer | index? | -1 | The material index to apply (-1 means all indices) |
| string | attachable_id? | | The attachable ID (set with AddSkeletalMeshAttached or AddStaticMeshAttached) to apply the material parameter. Pass empty to set on main mesh only |
See also GetMaterialVectorParameter.
SetPhysicalMaterialโ
Overrides this Actor's Physical Material with a new one
my_paintable:SetPhysicalMaterial(physical_material_path)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Material Reference | physical_material_path | Required parameter | The Physical Material to override |