CCG/Interior

From TrainzOnline
< CCG
Jump to: navigation, search

Contents

KIND: INTERIOR

Description

A traincar interior asset. It allows the interior mesh model to be defined, and has attached levers and controls to operate a locomotive in cab model. It also creates an interior for rolling stock.

Container Structure

A well formed interior kind has the following container structure:

CCG interior dir.jpg

See Chapter 7 for an example asset of this kind.

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

kind                      "interior"
kuid                      kuid
trainz-build              data
category-class            data
category-region           data
category-era              data
username                  data
cameradefault             data
cameralist
camera0                   data
camera1                   data
camera2                   data
camera3                   data
camera4                   data
camera5                   data
mesh-table
ampmeter_needle
kind                      data
mesh                      file
att                       data
limits                    data
angles                    data
att-parent                data
flow_needle
kind                      data
mesh                      file
att                       data
limits                    data
angles                    data
att-parent                data
bploco_equaliser
kind                      data
mesh                      file
att                       data
limits                    data
att-parent                data
bplocomain_needle
kind                      data
mesh                      file
att                       data
limits                    data
att-parent                data
bptrainbrakecylinder_needle
kind                      data
mesh                      file
att                       data
limits                    data
att-parent                data
bptrainbrakepipe_needle
kind                      data
mesh                      file
att                       data
limits                    data
att-parent                data
speedo_needle
kind                      data
mesh                      file
att                       data
limits                    data
att-parent                data
dynamicbrake_lever
kind                      data
mesh                      file
att                       data
limits                    data
angles                    data
notches                   data
notchheight               data
att-parent                data
independantbrake_lever
kind                      data
mesh                      file
att                       data
limits                    data
angles                    data
notches                   data
notchheight               data
mousespeed                data
att-parent                data
reverser_lever
kind                      data
mesh                      file
att                       data
limits                    data
angles                    data
notches                   data
notchheight               data
att-parent                data
throttle_lever
kind                      data
mesh                      file
att                       data
limits                    data
angles                    data
notches                   data
notchheight               data
mousespeed                data
att-parent                data
trainbrakelap_lever
kind                      data
mesh                      file
att                       data
limits                    data
angles                    data
notches                   data
notchheight               data
mousespeed                data
att-parent                data
horn
kind                      data
mesh                      file
att                       data
limits                    data
angles                    data
notches                   data
notchheight               data
mousespeed                data
att-parent                data
light_switch
kind                      data
mesh                      file
att                       data
limits                    data
angles                    data
notches                   data
notchheight               data
mousespeed                data
radius                    data
att-parent                data
ampmeter
mesh                      file
bploco
mesh                      file
bptrain
mesh                      file
brakepressure
mesh                      file
chair
mesh                      file
controlstand
mesh                      file
horizblinds
mesh                      file
interior_main
mesh                      file
speedo
mesh                      file
westinghouse
mesh                      file
windows
mesh                      file
opacity                   data
wheelslip_light
kind                      data
mesh                      file
att                       data
att-parent                data
default
mesh                      file
auto-create               data
thumbnails
0
image                     file
width                     data
height                    data


TAGS AND CONTAINERS

The following tags are further defined in Chapter 5:

kuid
Generated automatically by Content Manager.
trainz-build
Automatically set to 2.9 for 2009 assets.
category-class
Should be "ZI" - Interior. See the "Train Parts" section Category Class.
category-region
See Category Region for a list of valid category-region values.
category-era
See Category Era for a list of valid category-era values.
kind
Must be "interior".

Mesh Table

kind
The type of interior object the particular mesh defines. It affects the behavior of the mesh in Trainz.
Kinds
lever - Levers, switches, dials etc.
animated-lever - Animated Levers etc. eg. in steam cabs.
collision-proxy - Mouse collisions for animated levers.
needle - Gauge needles (i.e. Speedo, brake pres.).
pullrope - Pull rope horn as in the F7.
light - Wheelslip light.
limits
Mathematical boundaries Trainz uses to determine the objects function. These values vary as different objects use different mathematical units.
angles
Rotational boundaries in radians relative to its attachment point. Refer to the radian/degree circle diagram below:

CCG degrees to radians.jpg


notches
The position of notches within the angle boundaries. These are represented as decimal points between and including 0 and 1.
notchheight
The size of the notches specified.
radius
The notch position relative to the attachment point.
mousespeed
This controls the use of the mouse on screen. Use thiso control the mouse speed and push/pull direction for levers and dials.
· mousespeed -1 Inverts mouse direction.
· mousespeed 2 Doubles mouse speed in default direction.
· mousespeed -0.5 Inverts mouse direction and halves the speed.
test-collisions
Mouse cannot be used for this mesh, collision mesh used instead. i.e. animated-levers.
opacity
Usually used for the window mesh to give transparency (and the impression of reflection).


Additional Containers

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

CameraList Container

Contains a list of camera coordinates for the interior cameras relative to a.cabfront.

camera0, camera1 etc
A camera contains 5 numeric coordinates that determine the placement and orientation of the camera. These are:
0,0,0,0,0 =left/right, front/back, up/down, yaw, pitch
To determine these variables add -freeintcam to the trainzclassicoptions.txt file. Pan around the interior using arrow keys and mouse. See Page 386 for information. Co-ordinates are displayed at bottom-left of screen.


Additional Tags

cameradefault
The in-cab camera view Trainz defaults to when entering the cab.

Extra notes on modelling interiors can be found on Page 358.

Interior Attachment types

These values should be used as the name of your mesh table entries when constructing an interior (ie a throttle should be called "throttle_lever").

pantograph_lever
Pantograph lever/switch. For raising and lowering pantographs on electric locos.
horn
Locomotive's horn.
independantbrake_lever
Independent (Loco) brake lever.
reverser_lever
Reverser lever (Forward/Neutral/Reverse).
throttle_lever
Throttle / power handle.
trainbrake_lever
Train brake lever - self lapping.
trainbrakelap_lever
Train brake lever with lap position.
dynamicbrake_lever
For selecting dynamic brake.
bplocomain_needle
Main reservoir pressure needle
bploco_equalizer
Equalising reservoir pressure needle.
bptrainbrakepipe_needle
Brake pipe pressure needle.
bptrainbrakecylinder_needle
Brake cylinder pressure needle.
speedo_needle
Speedometer needle.
ampmeter_needle
Power meter needle.
flow_needle
Flow gauge needle.
windows
Textured mesh with low opacity (semi-transparent) to give impression of reflection. This mesh has the same 3D origin point as the main .im mesh, therefore does not require an attachment point.
wheelslip_light
A warning light mesh that is only visible when the locomotive loses traction. This mesh has the same 3D origin point as the main .im model, therefore does not require an attachment point
switch0, switch1 etc
Switches.
light_switch
Headlight switch.


THIS KIND SUPPORTS 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, CameraList, SoundScript Container, Mesh Table.
TAGS
kuid, trainz-build, category-class, category-region, category-era, username, kind, cameradefault, alias, 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, icon0, icon1, icon2, icon3, license, organisation, preview-mesh- kuid, preview-scale, script, username-cn, username-cz, username-de, username-es, username-fr, username-it, username-nl, username-pl, username-ru.


Return to CCG Index

Content Creator's Guide

Personal tools