CCG/Activity

KIND: ACTIVITY

Description

An activity is a scripted scenario that details the locomotives and rolling-stock used in a map, the driver settings, commands and scripts.

A train driver can undertake a sequence of planned moves ­ a scenario.

Container Structure

A well formed activity kind has the following container structure:

See Chapter 7 for an example asset of this kind.

A TYPICAL ASSET OF THIS KIND MAY HAVE THE FOLLOWING TAGS:

       activity

       kuid  		kuid

       trainz-build 	data

       category-class  	data

       category-region 	data

       category-era 	data

       username  	data

       kind 		data

       class 		data

       script		file

       driver-settings

       autopilotmode 	data

       startingtime 	data

       timerate 		data

       deraillevel 	data

       showhelp 		data

       controlmethod 	data

       weather 		data

       changeability	data

       thumbnails

       image		file

       width		data

       height 		data

TAGS AND CONTAINERS

The following tags are further defined in Chapter 5:

kuid

Generated automatically

trainz-build

Automatically set to 2.5 for 2006 assets.

category-class

Should be "YS - Scenario". See the "Maps & Scenarios" section of the "Classes and Codes" appendix located at the end of this document.

category-region

See the "Region Codes" appendix located at the end of this document for a list of valid category-region values.

category-era

See the "Era Codes" appendix located at the end of this document for a list of valid category-era values.

username

Asset username. Though this asset doesn't appear in the Surveyor menu, the username is used to identify the asset in the "Content Manager Plus" and "Content Creator Plus" programs.

kind

Must be "activity".

class

The name of the scenario class within the script file.

script

The script file (gs or gse file).

Additional Containers

As well as containing all of the common tags and containers detailed in Chapter 5, the Activity kind also contains additional containers and tags that are specialised to the requirements of the kind.

driver-settings

Specify the settings of this scenario, similar to Driver's settings' screen.

The driver settings container contains the following child tags:

autopilotmode AI driver setting. (off, on)

startingtime

Time of day. Range is from 0 to 1 (0.5 - midday).

timerate

Time progression. (1 - real-time, 2 - double speed etc.)

deraillevel

Derail setting. (none, arcade, realistic)

showhelp

Show Driver Help. (off, on)

controlmethod Driver control setting. (dcc, cabin)

weather

Weather setting. (clear, cloudy, drizzle, rain, stormy, light snow, medium snow, heavy snow)

changeability

Propensity for weather to change. (none, periodic, extreme)

Additional Tags

username

Name of scenario displayed in TRS.

scriptlibrary

Obsolete. Now replaced with the "script" tag.

scriptclass

Obsolete. Replaced with the "class" tag.

Notes: Scripted scenarios are made available for backwards compatibility reasons.

THIS KIND HAS THE FOLLOWING:

CONTAINERS:

String Table, Chinese String Table, Czech String Table, Dutch String Table, French String Table, German String Table, Italian String Table, Polish String Table, Russian String Table, Spanish String Table, KUID Table, Obsolete Table, Thumbnails, Privileges, Extensions, Driver Settings Container.

TAGS:

kuid, trainz-build, category-class, category-region, category-era, username, kind, author, category-keyword, class, contact-email, contact-website, description, description-cn, description-cz, description-de, description-es, description-fr, description-it, description-pl, description-nl, description-ru, license, organisation, script, username-cn, username-cz, username-de, username-es, username-fr, username-it, username-nl, username-pl, username-ru