Documentation index for AI agents (llms.txt) A Markdown version of every page is available: request the page's source under /docs/, follow the "alternate" link in this page's head, or start from /llms.txt.
Visual Script logo Manual

Set Canvas Scaler Default Sprite DPI#

UI / Layout / Canvas Scaler / Set Canvas Scaler Default Sprite DPI

Description#

Sets the Default Sprite DPI property of Canvas Scaler component

Parameters#

Name Description
Canvas Scaler
Value

Code#

// <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 Scaler Default Sprite DPI")]
    [Category("UI/Layout/Canvas Scaler/Default Sprite DPI")]
    [Description("Sets the Default Sprite DPI property of Canvas Scaler component")]
    
    [Image(typeof(IconCanvasScaler), ColorTheme.Type.TextLight)]
    [Keywords("UI, Layout")]
    
    [Parameter("Canvas Scaler")]
    [Parameter("Value")]
    
    [Serializable]
    public class GenInstructionNumber_CanvasScaler_SetDefaultSpriteDPI : Instruction
    {
        [SerializeField] private GetGameObject m_CanvasScaler = new GetGameObject(
            new GenTypeGameObject_CanvasScaler()
        );
        
        [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("Default Sprite DPI");
            return $"{this.m_CanvasScaler} {member} = {this.m_Value}{this.m_Transition}";
        }
        
        protected override async Awaitable Run(Args args)
        {
            CanvasScaler component = this.m_CanvasScaler.Get<CanvasScaler>(args);
            if (component == null) return;
            
            bool wait = this.m_Transition.Await;
            this.m_IsComplete = false;
            
            TweenManager.Run(new TweenInstanceInput<float>(
                component,
                "defaultSpriteDPI",
                component.defaultSpriteDPI,
                (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 CanvasScaler componentCanvasScaler) return;
            componentCanvasScaler.defaultSpriteDPI = value;
        }
        
        private void OnFinish() => this.m_IsComplete = true;
        
        private bool IsComplete() => this.m_IsComplete;
    }
}

Visual Script logoVisual Script © Catsoft Works 2026. All rights reserved.