templatePlayer

Used with the set command to set the properties of newly created players.

# Metadata

Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:

# Syntax

templatePlayer

# Examples

set the alwaysBuffer of the templatePlayer to true

# Description

Use the templatePlayer keyword to set up default properties to be used for any new players you create.

The templatePlayer can be thought of as a special, abstract object. It is not an actual player, but it has all the properties of a player. The ID property of the templatePlayer is zero.

You can use the set command to set the properties of the templatePlayer before creating a player. The new player has the properties of the templatePlayer, by default. Changing the properties of the templatePlayer does not affect existing players.

The properties of the templatePlayer can be returned to the default settings using the reset command.

You can refer to the templatePlayer using any of the following forms:

templatePlayer the templatePlayer templatePlayer()

>*Note:* The templatePlayer keyword is implemented internally as a > function and appears in the functionNames. However, it cannot be > used as a function in an expression.

# Tags

# See

- **property:** properties, ID - **control structure:** function - **keyword:** templateScrollbar, default, player - **object:** player - **glossary:** object, keyword, property, command, expression - **command:** reset, set - **function:** functionNames