User Tools

Site Tools


columns_ui:config:global_variables

This is an old revision of the document!


Global variables

About

Global variables were created as a way of speeding up playlist formatting, by separating the parts of formatting that is common to all your columns, and only processing it once per track instead of once per column. It works by defining variables which you can access in your column display strings.

Note: Information on the legacy format for global variables can be viewed here.

Global variables string

This string, in the globals configuration page, is where you define your variables.

Setting variables

You can set variables in your global variables string using the set_global function. The syntax is as follows:

Standard-syntax titleformatting Script-syntax titleformatting
$set_global(variable name,variable value) set_global(variable name,variable value)

Note: You can only define globals in the global string - i.e. you cannot access defined globals.

The truth value of a call to set_global with the correct number of parameters is true.

Accessing global variables

You can access global variables in your display and style strings using the get_global function. The syntax is as follows:

Standard-syntax titleformatting Script-syntax titleformatting
$get_global(variable name) get_global(variable name)

where

  • variable name is the name of the variable as defined in the set_global function call
  • the return value is the variable value

The truth value of a call to get_global with the correct number of parameters is true iff the variable has been set in a previous call to set_global, irrespective of what the variable was set to.

Notes on using the script-syntax

Things to remember:

  • Strings are enclosed in quotation marks. For example:
    get_global("my_var");
  • To print a string you must use the print() function. For example:
    print(get_global("my_var"));
columns_ui/config/global_variables.1357421331.txt.gz · Last modified: 2013/01/05 21:28 (external edit)