diff --git a/objects/DirectionalLight.md b/objects/DirectionalLight.md index 557fcbc..2847c8d 100644 --- a/objects/DirectionalLight.md +++ b/objects/DirectionalLight.md @@ -1,23 +1,27 @@ # Directional Light ### Type + pre-defined ### 3D + No visible mesh. Represents a scene-wide directional light source (like the sun). The `target` arg defines the direction the light points toward. Default spawn height is y=5. ### Custom Args: -| Key | Type | Implemented | Description | -|---|---|---|---| -| color | hexColor | ⚠️ (Creator tbd) | Color of the light | -| intensity | float | ⚠️ **See note below.** | Light intensity (default tbd). | -| target | string `"x,y,z"` | ⚠️ (Unity only reads rotation) | World-space look-at point the light aims at | -| grabable | `"true"` / `"false"` | ⚠️ | Whether the item can be grabbed in-experience (common to all types) | + +| Key | Type | Implemented | Description | +| --------- | -------------------- | ------------------------------ | ------------------------------------------------------------------- | +| color | hexColor | ⚠️ (Creator tbd) | Color of the light | +| intensity | float | ✔️ | Light intensity (default 1). | +| target | string `"x,y,z"` | ⚠️ (Unity only reads rotation) | World-space look-at point the light aims at | +| grabable | `"true"` / `"false"` | ⚠️ | Whether the item can be grabbed in-experience (common to all types) | ### Special Notes: -**Key name discrepancy:** The database save format uses `intensity` as the argument key, but `LightManupulationBehaviour.cs` reads `brightness`. Light intensity args may not apply at runtime unless this is resolved. + +**Key name discrepancy:** The database save format uses `intensity` as the argument key. `LightManupulationBehaviour.cs` read `brightness` and "intensity". ### Example: @@ -25,13 +29,13 @@ Default spawn height is y=5. { "position": { "x": 0.0, "y": 5.0, "z": 0.0 }, "rotation": { "x": 0.0, "y": 0.0, "z": 0.0 }, - "scale": { "x": 1.0, "y": 1.0, "z": 1.0 }, + "scale": { "x": 1.0, "y": 1.0, "z": 1.0 }, "type": "pre-defined", "resourcename": "Directional Light", "item-custom-args": [ - { "argument": "color", "value": "#ffffff" }, + { "argument": "color", "value": "#ffffff" }, { "argument": "intensity", "value": "20" }, - { "argument": "target", "value": "0,0,0" } + { "argument": "target", "value": "0,0,0" } ], "item-custom-args-adv": null } diff --git a/objects/PointLight.md b/objects/PointLight.md index 76c5ce2..3da0127 100644 --- a/objects/PointLight.md +++ b/objects/PointLight.md @@ -1,21 +1,25 @@ # Point Light ### Type + pre-defined ### 3D + No visible mesh. Represents an omnidirectional point light source that emits light equally in all directions. Default spawn height is y=2. ### Custom Args: -| Key | Type | Implemented | Description | -|---|---|---|---| -| color | hexColor | ⚠️ (Creator tbd) | Color of the light | -| intensity | float | ⚠️ **See note below.** | Light intensity (default 1). | -| grabable | `"true"` / `"false"` | ⚠️ | Whether the item can be grabbed in-experience (common to all types) | + +| Key | Type | Implemented | Description | +| --------- | -------------------- | ---------------- | ------------------------------------------------------------------- | +| color | hexColor | ⚠️ (Creator tbd) | Color of the light | +| intensity | float | ✔️ | Light intensity (default 1). | +| grabable | `"true"` / `"false"` | ⚠️ | Whether the item can be grabbed in-experience (common to all types) | ### Special Notes: -**Key name discrepancy:** The database save format uses `intensity` as the argument key, but `PointLightItemBehaviour.cs` reads `brightness`. Light intensity args may not apply at runtime unless this is resolved. + +**Key name discrepancy:** The database save format uses `intensity` as the argument key. `LightManupulationBehaviour.cs` read `brightness` and "intensity". ### Example: @@ -23,11 +27,11 @@ Default spawn height is y=2. { "position": { "x": 0.0, "y": 2.0, "z": 0.0 }, "rotation": { "x": 0.0, "y": 0.0, "z": 0.0 }, - "scale": { "x": 1.0, "y": 1.0, "z": 1.0 }, + "scale": { "x": 1.0, "y": 1.0, "z": 1.0 }, "type": "pre-defined", "resourcename": "Point Light", "item-custom-args": [ - { "argument": "color", "value": "#ff0000" }, + { "argument": "color", "value": "#ff0000" }, { "argument": "intensity", "value": "50" } ], "item-custom-args-adv": null