modify_scene_settings
Adjust scene settings such as physics, lighting, and fog in PlayCanvas Editor. Customize gravity, fog type, lightmap resolution, and more to optimize 3D web application environments.
Instructions
Modify the scene settings
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| settings | Yes | Scene settings. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"settings": {
"additionalProperties": false,
"description": "Scene settings.",
"properties": {
"physics": {
"additionalProperties": false,
"description": "Physics related settings for the scene.",
"properties": {
"gravity": {
"description": "An array of 3 numbers that represents the gravity force. Default: [0, -9.8, 0]",
"items": [
{
"description": "X",
"type": "number"
},
{
"description": "Y",
"type": "number"
},
{
"description": "Z",
"type": "number"
}
],
"maxItems": 3,
"minItems": 3,
"type": "array"
}
},
"type": "object"
},
"render": {
"additionalProperties": false,
"description": "Render related settings for the scene.",
"properties": {
"ambientBake": {
"description": "Enable baking the ambient lighting into lightmaps. Default: false.",
"type": "boolean"
},
"ambientBakeNumSamples": {
"description": "Number of samples to use when baking ambient. Default: 1.",
"type": "number"
},
"ambientBakeOcclusionBrightness": {
"description": "Specifies the ambient occlusion brightness. Typical range is -1 to 1. Default: 0.",
"type": "number"
},
"ambientBakeOcclusionContrast": {
"description": "Specifies the ambient occlusion contrast. Typical range is -1 to 1. Default: 0.",
"type": "number"
},
"ambientBakeSpherePart": {
"description": "How much of the sphere to include when baking ambient. Default: 0.4.",
"type": "number"
},
"clusteredLightingEnabled": {
"description": "Enable the clustered lighting. Default: true.",
"type": "boolean"
},
"exposure": {
"description": "The exposure value tweaks the overall brightness of the scene. Default: 1.0.",
"type": "number"
},
"fog": {
"description": "The type of fog used in the scene. Can be one of `pc.FOG_NONE`, `pc.FOG_LINEAR`, `pc.FOG_EXP`, `pc.FOG_EXP2`. Default: `none`.",
"enum": [
"none",
"linear",
"exp",
"exp2"
],
"type": "string"
},
"fog_color": {
"description": "An array of 3 numbers representing the color of the fog. Default: [0.0, 0.0, 0.0].",
"items": [
{
"description": "Red",
"maximum": 1,
"minimum": 0,
"type": "number"
},
{
"description": "Green",
"maximum": 1,
"minimum": 0,
"type": "number"
},
{
"description": "Blue",
"maximum": 1,
"minimum": 0,
"type": "number"
}
],
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"fog_density": {
"description": "The density of the fog. This property is only valid if the fog property is set to `pc.FOG_EXP` or `pc.FOG_EXP2`. Default: 0.01.",
"minimum": 0,
"type": "number"
},
"fog_end": {
"description": "The distance from the viewpoint where linear fog reaches its maximum. This property is only valid if the fog property is set to `pc.FOG_LINEAR`. Default: 1000.0.",
"minimum": 0,
"type": "number"
},
"fog_start": {
"description": "The distance from the viewpoint where linear fog begins. This property is only valid if the fog property is set to `pc.FOG_LINEAR`. Default: 1.0.",
"minimum": 0,
"type": "number"
},
"gamma_correction": {
"anyOf": [
{
"const": 0,
"description": "GAMMA_NONE",
"type": "number"
},
{
"const": 1,
"description": "GAMMA_SRGB",
"type": "number"
}
],
"description": "The gamma correction to apply when rendering the scene. Default: 1 (GAMMA_SRGB)."
},
"global_ambient": {
"$ref": "#/properties/settings/properties/render/properties/fog_color",
"description": "An array of 3 numbers representing the color of the scene's ambient light. Default: [0.2, 0.2, 0.2]."
},
"lightingAreaLightsEnabled": {
"description": "Cluster lights support area lights. Default: false.",
"type": "boolean"
},
"lightingCells": {
"$ref": "#/properties/settings/properties/physics/properties/gravity",
"description": "Number of cells along each world-space axis the space containing lights is subdivided into. Default: [10, 3, 10]."
},
"lightingCookieAtlasResolution": {
"description": "Resolution of the atlas texture storing all non-directional cookie textures. Default: 2048.",
"type": "number"
},
"lightingCookiesEnabled": {
"description": "Cluster lights support cookies. Default: false.",
"type": "boolean"
},
"lightingMaxLightsPerCell": {
"description": "Maximum number of lights a cell can store. Default: 255.",
"type": "number"
},
"lightingShadowAtlasResolution": {
"description": "Resolution of the atlas texture storing all non-directional shadow textures. Default: 2048.",
"type": "number"
},
"lightingShadowType": {
"anyOf": [
{
"const": 0,
"description": "SHADOW_PCF3_32F",
"type": "number"
},
{
"const": 4,
"description": "SHADOW_PCF5_32F",
"type": "number"
},
{
"const": 5,
"description": "SHADOW_PCF1_32F",
"type": "number"
}
],
"description": "The type of shadow filtering used by all shadows. Default: 0 (SHADOW_PCF3_32F)."
},
"lightingShadowsEnabled": {
"description": "Cluster lights support shadows. Default: true.",
"type": "boolean"
},
"lightmapFilterEnabled": {
"description": "Enable filtering of lightmaps. Default: false.",
"type": "boolean"
},
"lightmapFilterRange": {
"description": "A range parameter of the bilateral filter. Default: 10.",
"type": "number"
},
"lightmapFilterSmoothness": {
"description": "A spatial parameter of the bilateral filter. Default: 0.2.",
"type": "number"
},
"lightmapMaxResolution": {
"description": "The maximum lightmap resolution. Default: 2048.",
"type": "number"
},
"lightmapMode": {
"anyOf": [
{
"const": 0,
"description": "BAKE_COLOR",
"type": "number"
},
{
"const": 1,
"description": "BAKE_COLORDIR",
"type": "number"
}
],
"description": "The lightmap baking mode. Default: 1 (BAKE_COLORDIR)."
},
"lightmapSizeMultiplier": {
"description": "The lightmap resolution multiplier. Default: 16.",
"type": "number"
},
"skyCenter": {
"$ref": "#/properties/settings/properties/physics/properties/gravity",
"description": "An array of 3 numbers representing the center of the sky mesh. Default: [0.0, 0.1, 0.0]."
},
"skyMeshPosition": {
"$ref": "#/properties/settings/properties/physics/properties/gravity",
"description": "An array of 3 numbers representing the position of the sky mesh. Default: [0.0, 0.0, 0.0]."
},
"skyMeshRotation": {
"$ref": "#/properties/settings/properties/physics/properties/gravity",
"description": "An array of 3 numbers representing the rotation of the sky mesh. Default: [0.0, 0.0, 0.0]."
},
"skyMeshScale": {
"$ref": "#/properties/settings/properties/physics/properties/gravity",
"description": "An array of 3 numbers representing the scale of the sky mesh. Default: [100.0, 100.0, 100.0]."
},
"skyType": {
"description": "Type of skybox projection. Default: `infinite`.",
"enum": [
"infinite",
"box",
"dome"
],
"type": "string"
},
"skybox": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The `id` of the cubemap texture to be used as the scene's skybox. Default: null."
},
"skyboxIntensity": {
"description": "Multiplier for skybox intensity. Default: 1.",
"type": "number"
},
"skyboxMip": {
"description": "The mip level of the skybox to be displayed. Only valid for prefiltered cubemap skyboxes. Default: 0.",
"maximum": 5,
"minimum": 0,
"type": "integer"
},
"skyboxRotation": {
"$ref": "#/properties/settings/properties/physics/properties/gravity",
"description": "An array of 3 numbers representing the rotation of the skybox. Default: [0, 0, 0]."
},
"tonemapping": {
"description": "The tonemapping transform to apply when writing fragments to the frame buffer. Default: 0.",
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"settings"
],
"type": "object"
}