Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetPositionsSelf(Vector3[], bool)

Sets the positions of the baked light probes stored in this LightProbes object.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public bool SetPositionsSelf(Vector3[] positions, bool checkForDuplicatePositions)

Parameters

positions

Vector3[]
The positions to set.

checkForDuplicatePositions

bool
Whether to check for duplicate light probe positions at the cost of performance.

Returns

Type

Description

bool
true
when the positions were successfully set. Otherwise 
false
.

Remarks

When you change the positions of baked light probes using this method, you must call LightProbes.Tetrahedralize or LightProbes.TetrahedralizeAsync to fully apply the changes.
Setting duplicate light probe positions will lead to incorrect behavior, such as black light probes appearing..
The following script additively loads a scene containing baked light probes and moves the probes:
using System.Collections;using UnityEngine;using UnityEngine.SceneManagement;public class MoveLightProbesExample : MonoBehaviour{    void Start()    {        StartCoroutine(LoadSceneAndMoveLightProbes());    }    IEnumerator LoadSceneAndMoveLightProbes()    {        // Fully load a scene containing light probes additively.        Scene additiveScene = SceneManager.LoadScene("AdditiveScene", new LoadSceneParameters(LoadSceneMode.Additive));        yield return null;        // Get the light probes for the scene.        LightProbes lightProbes = LightProbes.GetInstantiatedLightProbesForScene(additiveScene);        // Move the light probes slightly.        Vector3[] positions = lightProbes.GetPositionsSelf();        for (int i = 0; i < positions.Length; i++)        {            positions[i] += Vector3.one;        }        lightProbes.SetPositionsSelf(positions, true);        // Tetrahedralize to apply the changes to light probe positions.        LightProbes.TetrahedralizeAsync();    }}
Additional Resources: LightProbes.countSelf.