File tree Expand file tree Collapse file tree 1 file changed +7
-0
lines changed
Expand file tree Collapse file tree 1 file changed +7
-0
lines changed Original file line number Diff line number Diff line change @@ -20,22 +20,29 @@ type UnityProvider = Pick<
2020> & {
2121 /**
2222 * Sets the Unity Context's loading progression.
23+ * This is used to track the loading state of the Unity instance.
24+ * @param loadingProgression The loading progression to set, typically a value between 0
2325 */
2426 readonly setLoadingProgression : ( loadingProgression : number ) => void ;
2527
2628 /**
2729 * Sets the Unity Context's loaded state.
30+ * This is used to indicate whether the Unity instance has finished loading.
31+ * @param isLoaded The loaded state to set, true if loaded, false otherwise.
2832 */
2933 readonly setIsLoaded : ( isLoaded : boolean ) => void ;
3034
3135 /**
3236 * Sets the Unity Context's initialisation error.
37+ * This is used to handle errors that occur during the initialisation of the Unity instance.
38+ * @param error The error to set, or undefined to clear the error.
3339 */
3440 readonly setInitialisationError : ( error ?: Error ) => void ;
3541
3642 /**
3743 * Sets the Unity instance, used for internally managing the Unity instance
3844 * between the context and the UnityProvider.
45+ * @param unityInstance The Unity instance to set, or null to clear it.
3946 */
4047 readonly setUnityInstance : ( unityInstance : UnityInstance | null ) => void ;
4148} ;
You can’t perform that action at this time.
0 commit comments