<< Click to Display Table of Contents >> Navigation:  Advanced Features > Introduction to VERTEX Scripting

•Scripting is the automation and control layer in VERTEX.

•Script commands are used across all features of VERTEX, for instance:
to control playback, jump to cues, change property values, fade values, trigger devices, run Control View actions, execute scheduled events, and automate complex workflows.

Where Vertex scripts are typically used:

 

This topic covers the common scripting concepts, syntax, tools, and reference material. Script and workflow examples that belong to a particular project item or feature can be found in the feature-specific topics of this manual.

 

 

This chapter serves two purposes:

1.Learning path: start here if you are new to VERTEX scripting.

2.Reference hub: return here when you need syntax rules, examples, tools, variables, conditions, reusable scripts, or advanced scripting options.

 

Basic Operation

 

VERTEX script commands follow the same object structure that you see in the user interface.

In many cases, you start with the item you want to control, then move through its child items, properties, or actions:

Object.ChildObject.Property.Operation value

 

Examples:

Playback1.Play
Playback1.GotoCue 2
Sequence1.ClipContainer1.Opacity.Value = 0.5
Playback1.MixLevel.FadeValue 1,3
System1.EnterFullScreen

 

A basic workflow for most scripting tasks is:

 

1. Click into a script field, the command line, or the Script Editor.

2. Press Ctrl+Space to open the Command Completion assistant.

3. Select the object, command, or property.

4. Use a dot to move to the next level.

5. Complete the command and run it.

6. Check Script Monitor for errors, status messages, or log output.

7. Move the tested command into the cue, button, schedule, trigger, device, or reusable Script item where it belongs.

 

You do not need to memorize every command. In all script fields, in the command line, or in the Script Editor, press Ctrl+Space to access the command completion assistant.
This will list all available items, commands, properties, and expected parameters. When typing a letter, the assistant will list available options starting with this letter. Type a dot after the initial command or item to continue listing options for the next object level.

 

Topic Guide

Find the right chapter for your task:

 

 

 

Recommended Learning Path

 

If you are new to scripting, read the following topics in this order:

 

1. Start with the command structure in VERTEX Scripting to learn how script commands are built.

 
This topic covers:

• object paths

• actions

• properties

• value assignment

• `Value`

• `FadeValue`

• comments

• tags

• local variables

• basic syntax rules

 

 

2. Use the Command Completion Assistant

 

•Command Completion is your best friend whenever you are not sure which command or property is available.

•Click into a script field or the command line, then press Ctrl+Space. This will open a list all available items, commands, properties, and expected parameters.

•Type a dot to continue to the next level:

 

3. Testing and Debugging in Script Editor and Script Monitor

 

This is where you will learn how to write, run, and troubleshoot scripts.

 

Use the Script Editor to:

 

• write new scripts

• edit existing scripts

• run scripts directly

• run scripts with parameter prompts

• access script code from cues, triggers, schedules, and timers

 

Use the Script Monitor to:

 

• view active scripts

• check script status

• find errors

• pause, resume, or cancel scripts

• inspect log output

 

4. Reuse Commands as Scripts

 

Go to the topic Scripts to learn how to combine multiple script commands into one reusable project item.

 

For example, the single project item Script1 may contain multiple command lines:

 

Playback1.GotoCue 2
Playback1.Play
Playback1.MixLevel.FadeValue 1,3

 

You can run this script from a cue, Control View button, schedule, trigger, command line, or another script field.

 

5. Add Logic and Stored Values

 

Learn about Conditional Scripts when a script should make decisions.

 

Learn about Variables when values need to be stored, reused, or shared across scripts.

 

6. Continue with Advanced Scripting (optional)

 

If you want to go beyond the basics, go to Advanced Scripting for power-user workflows, including advanced variables, dynamic scripting, indexers, and loops.

 

Other Scripting Languages will show you how to extend VERTEX scripting with Lua, Python, or C#.

 

 

Reference Hub for Experienced Users

 

Use the following topics when you already know the basics and need a specific scripting resource.

Command Syntax and Structure

 

Go to VERTEX Scripting for the core syntax rules:

 

FirstLevel.SecondLevel.ThirdLevel

 

Use this topic when you need to confirm how to address objects, properties, child elements, actions, values, comments, tags, or local variables.

 

Common Commands and Examples

 

Go to VERTEX Script Examples for ready-to-adapt examples grouped by project area, such as:

 

• System

• Playback

• Sequence

• Clip Container

• Content

• Control View

• Devices

• Backup systems

 

Use these examples as starting points, then adapt the object names to your project. Additional scripting examples can be found in the VERTEX sample projects. These can be loaded from the start screen and/ or MAIN MENU > FILE. The sample projects are a great way to discover the various use cases and solutions the VERTEX scripting can be applied to. Many scripts found there may be re-purposed as a template for your own projects.

Script Testing and Troubleshooting

 

Go to Script Editor and Script Monitor when a command does not behave as expected.

 

Use this topic to check how to:

 

• run a script

• run a script with prompt

• monitor active scripts

• inspect errors

• log values

• jump from Script Monitor entries back to the relevant script line

 

Reusable Scripts and Parameters

 

Go to Scripts when the same sequence of commands is needed in more than one place.

 

Use parameters when the script logic stays the same but the values change.

 

Example:

 

Script1 0,1,5

 

Variables and Conditions

 

Go to Variable for global and local variables.

 

Go to Conditional Scripts for logic based on values, states, or project conditions.

 

Advanced Scripting Patterns

 

Go to Advanced Scripting for:

 

• advanced variables

• dynamic scripting

• indexers

• loops

 

These topics are intended for users who already understand the basic VERTEX script command structure.

 

External Control and Integrations

 

Go to VERTEX Remote Script API when an external application, control system, or custom service needs to send VERTEX script commands.

 

Go to Other Scripting Languages when you need to use Lua, Python, or C# from inside VERTEX while still interacting with VERTEX script commands.

 

 

 

Version note

 

Available script commands and syntax options can depend on the installed VERTEX version. When in doubt, use Command Completion in the version you are currently running to see which objects, properties, commands, and parameters are available.