Skip to content

Comment

Comment

Allows notes or documentation to be added within a script for organizational purposes.

Properties

System

Name Explanation Type
Comment The comment text to display within the script for documentation or note-taking purposes. String

Examples

Add a Single Line Comment

This adds a comment to the script for documentation purposes. Comments are ignored during execution.

// This is a comment
{"Data":{"Comment":"This is a comment","Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Flow.CommentCommand"}

Add a Multi-Line Comment

This adds a multi-line comment spanning two lines. Each line is prefixed with the comment marker.

// First line of the comment
// Second line of the comment
{"Data":{"Comment":"First line of the comment\nSecond line of the comment","Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Flow.CommentCommand"}