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

Sum#

Collections / Sum

  • Can Read

  • Cannot Write

Description#

Adds up every item of a collection read as a number

Parameters#

Name Description
Collection The collection whose items are added up

Code#

using System;
using UnityEngine;
using VisualScript.Icons;

namespace VisualScript.Runtime
{
    [Get]

    [Title("Sum")]
    [Category("Collections/Sum")]

    [Description("Adds up every item of a collection read as a number")]
    [Image(typeof(IconSigma), ColorTheme.Type.Teal)]

    [Parameter("Collection", "The collection whose items are added up")]

    [Keywords("Add", "Total", "Accumulate", "Aggregate", "List", "Array")]

    [Serializable]
    public class TypeNumberCollectionSum : TypeNumber
    {
        [SerializeField] private GetCollection m_Collection = new GetCollection();

        public override double Get(Args args)
        {
            using Args scoped = Args.Get(args);

            int count = this.m_Collection.Capture(scoped);
            double sum = 0f;

            for (int i = 0; i < count; ++i)
            {
                if (ArgsCollectionParameters.TryGetItem(this.m_Collection, scoped, i, out double item))
                {
                    sum += item;
                }
            }

            return sum;
        }

        public override string ToString()
        {
            return $"Sum of {this.m_Collection}";
        }

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