---
tags:
    - "UI, Layout"
---

# Set Canvas Plane Distance

[UI](../../index.md) / [Layout](../index.md) / [Canvas](index.md) / **Set Canvas Plane Distance**

## Description

Sets the Plane Distance property of Canvas component

## Parameters

| Name | Description |
| :--- | :---------- |
| Canvas |  |
| Value |  |

## Code

```cs
// <auto-generated>
// This script was automatically generated using the Visual Script Transpiler.
// Do not modify. Changes to this file will be lost when updating the package.
// </auto-generated>

using System;
using UnityEngine;
using VisualScript.Icons;
using UnityEngine.UI;

namespace VisualScript.Runtime
{
    [Title("Set Canvas Plane Distance")]
    [Category("UI/Layout/Canvas/Plane Distance")]
    [Description("Sets the Plane Distance property of Canvas component")]
    
    [Image(typeof(IconCanvas), ColorTheme.Type.TextLight)]
    [Keywords("UI, Layout")]
    
    [Parameter("Canvas")]
    [Parameter("Value")]
    
    [Serializable]
    public class GenInstructionNumber_Canvas_SetPlaneDistance : Instruction
    {
        [SerializeField] private GetGameObject m_Canvas = new GetGameObject(
            new GenTypeGameObject_Canvas()
        );
        
        [SerializeField] private GetNumber m_Value = new GetNumber();
        
        [SerializeField] private TweenTransition m_Transition = new TweenTransition();
        
        [NonSerialized] private bool m_IsComplete;
        
        protected override string GetTitle(GameObject source)
        {
            string member = TextUtils.ThemeAsKeyword("Plane Distance");
            return $"{this.m_Canvas} {member} = {this.m_Value}{this.m_Transition}";
        }
        
        protected override async Awaitable Run(Args args)
        {
            Canvas component = this.m_Canvas.Get<Canvas>(args);
            if (component == null) return;
            
            bool wait = this.m_Transition.Await;
            this.m_IsComplete = false;
            
            TweenManager.Run(new TweenInstanceInput<float>(
                component,
                "planeDistance",
                component.planeDistance,
                (float) this.m_Value.Get(args),
                this.OnUpdate,
                wait ? this.OnFinish : null,
                this.m_Transition.GetDuration(args),
                this.m_Transition.EaseMode,
                this.m_Transition.TimeMode
            ));
            
            if (wait) await this.Until(this.IsComplete);
        }
        
        private void OnUpdate(Component component, float value)
        {
            if (component is not Canvas componentCanvas) return;
            componentCanvas.planeDistance = value;
        }
        
        private void OnFinish() => this.m_IsComplete = true;
        
        private bool IsComplete() => this.m_IsComplete;
    }
}


```