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

Game Object Sprite#

Game Object / Game Object Sprite

  • Can Read

  • Cannot Write

Description#

The Sprite used by the Sprite Renderer or the Image component of a Game Object

Parameters#

Name Description
Game Object The Game Object the Sprite is read from

Code#

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

namespace VisualScript.Runtime
{
    [Get]

    [Title("Game Object Sprite")]
    [Category("Game Object/Game Object Sprite")]

    [Description("The Sprite used by the Sprite Renderer or the Image component of a Game Object")]
    [Image(typeof(IconSprite), ColorTheme.Type.Purple, typeof(BadgeCubeOutline))]

    [Parameter("Game Object", "The Game Object the Sprite is read from")]

    [Keywords("Sprite Renderer", "Image", "UI", "Texture", "Component", "Read")]

    [Serializable]
    public class TypeSpriteGameObject : TypeSprite
    {
        [SerializeField] private GetGameObject m_GameObject = new GetGameObject();

        public override Sprite Get(Args args)
        {
            GameObject gameObject = this.m_GameObject.Get(args);
            if (gameObject == null) return null;

            if (gameObject.TryGetComponent(out SpriteRenderer spriteRenderer)) return spriteRenderer.sprite;
            if (gameObject.TryGetComponent(out Image image)) return image.sprite;

            return null;
        }

        public override string ToString()
        {
            return $"{this.m_GameObject} Sprite";
        }

        protected override SubscriptionMode Subscription => SubscriptionMode.OnChange;
    }
}
Visual Script logoVisual Script © Catsoft Works 2026. All rights reserved.