==Driver-Command==

===Directory Structure===
A typical asset of this kind has the following File\Directory Structure:

[[Image:CCG_driver_command_dir1.jpg]]

===Required Files===

'''config.txt''' - The config file for the asset.

'''thumb.jpg''' - The thumbnail image for this asset. A 240x180 jpeg.

'''driveto.texture.txt''' - The texture.txt file. See the section on [[Texture_file|Texture.txt]] files for more information.

'''driveto.tga''' - The texture file for the drivercommand icon.

[[Image:example_driveto.jpg]] shows image and alpha channel for 64x64 pixel TGA.

'''drivetocommand.gs''' - The trainz script file referenced in the config.txt.

'''drivetoschedulecommand.gs''' - A trainz script file which is a dependency of "drivercommand.gs".

===Config.txt File Listing===
kuid <kuid:56113:1268>
trainz-build 2.5
category-class "YD"
category-region "00"
category-era "1800s;1810s;1820s"
username "testDriverCommand"
kind "drivercommand"
supports-null-driver-character 1
script "DriveToCommand.gs"
class "DriveToCommand"
description "Test command. This does the same thing as `Drive To'."
string-table
{
description "Allows a driver character to take a train either to a
destination industry or a specific track in a destination industry."
driver_command_drive_to "Drive To "
}
kuid-table
{
command-sounds <kuid:-3:10219>
}
thumbnails
{
0
{
image "thumb.jpg"
width 240
height 180
}
1
{
image "driveto.tga"
width 64
height 64
}
}

===DriverToCommand.gs File Listing===
//
// DriverToCommand.gs
//
// Copyright (C) 2003 Auran Developments Pty Ltd
// All Rights Reserved.
//
include "DriverCommand.gs"
include "World.gs"
include "Browser.gs"
include "KUID.gs"
include "Industry.gs"
include "DriveToScheduleCommand.gs"
//
// Driver command that allows a driver character to take a train either to a destination industry
// or a specific track in a destination industry.
//
class DriveToCommand isclass DriverCommand
{
//
// Initialize parent object and add handlers to process messages for this driver command object.
//
public void Init(Asset asset)
{
inherited(asset);
AddHandler(me, "DriveToIndustry", null, "DriveTo");
AddHandler(me, "DriveToIndustryTrack", null,"DriveToTrack");
}

//
// Adds industry destination menu items for all industries to the given menu along with submenus of
// destination tracks for all industries added.
//
public void AddCommandMenuItem(DriverCharacter driver,Menu menu)
{
Train train;
if (driver)
{
train = driver.GetTrain();
if (!train)
return;
}
StringTable strTable = GetAsset().GetStringTable();
Menu industriesMenu = Constructors.NewMenu();
GameObject[] industryList = World.GetIndustryList();
int i, industryCount = industryList.size();
if (!industryCount)
// we dont bother with a `Drive To' command if there are no industries
return;
for (i = 0; i < industryCount; i++)
{
Industry industry = cast<Industry>(industryList[i]);
string localisedName = industry.GetLocalisedName();
string[] locationNames = new string[0];
string[] locationTracks = new string[0];
industry.AppendDriverDestinations(locationNames,locationTracks);
if (localisedName.size())
if (locationNames.size())
{
Menu submenu = Constructors.NewMenu();
int j;
for (j = 0; j < locationNames.size(); j++)
if (locationNames[j] and locationNames[j].size() and locationTracks[j] and locationTracks[j].size())
submenu.AddItem(locationNames[j], me, "DriveToIndustryTrack", industry.GetId() + " " + locationTracks[j]);
else
if (train)
train.Exception("Error in `track names' of industry `" + localisedName + "'");
industriesMenu.AddSubmenu(localisedName + " >",submenu);
}
else
industriesMenu.AddItem(localisedName, me,"DriveToIndustry", industry.GetName());
}
industriesMenu.SubdivideItems();
menu.AddSubmenu(strTable.GetString("driver_command_drive_to") + " >", industriesMenu);
}

//
// Called by either DriveTo() or DriveToTrack() to play one of random driver acknowledgments.
//
void PlayConfirmation(void)
{
KUID kuid = GetAsset().LookupKUIDTable("command-sounds");
Library libCommandSounds = World.GetLibrary(kuid);
if (libCommandSounds)
libCommandSounds.LibraryCall("PlayConfirmation",null, null);
}

//
// Create the schedule command
//
DriverScheduleCommand CreateScheduleCommand(DriverCharacter driver, Soup soup)
{
DriveToScheduleCommand cmd = new DriveToScheduleCommand();
cmd.Init(driver, me);
cmd.SetParent(me);
cmd.SetProperties(soup);
return cast<DriverScheduleCommand>cmd;
}

//
// Handler method to drive a train to an industry (no specific destination track though).
//
void DriveTo(Message msg)
{
DriverCommands commands = GetDriverCommands(msg);
DriverCharacter driver = cast<DriverCharacter>(msg.src);
string industryName = msg.minor;
// schedule our command
Soup soup = Constructors.NewSoup();
soup.SetNamedTag("industryName", industryName);
DriveToScheduleCommand cmd = cast<DriveToScheduleCommand>CreateScheduleCommand(driver, soup);
commands.AddDriverScheduleCommand(cmd);
if (driver) PlayConfirmation();
}

//
// Handler method to drive a train to a specific track in an industry.
//
void DriveToTrack(Message msg)
{
DriverCommands commands = GetDriverCommands(msg);
DriverCharacter driver = cast<DriverCharacter>(msg.src);
string msgData = msg.minor;
int industryId = Str.UnpackInt(msgData);
string trackName = Str.UnpackString(msgData);
GameObject industry = Router.GetGameObject(industryId);
if (!industry) return;
// schedule our command
Soup soup = Constructors.NewSoup();
soup.SetNamedTag("industryName", industry.GetName());
soup.SetNamedTag("trackName", trackName);
DriveToScheduleCommand cmd = cast<DriveToScheduleCommand>CreateScheduleCommand(driver, soup);
commands.AddDriverScheduleCommand(cmd);
if (driver) PlayConfirmation();
}

};

And the dependent script

===DriveToScheduleCommand.gs File Fisting===
//
// DriveToScheduleCommand.gs
//
// Copyright (C) 2003 Auran Developments Pty Ltd
// All Rights Reserved.
//
include "DriverCommand.gs"
include "World.gs"
include "Browser.gs"
include "KUID.gs"
include "Industry.gs"
include "DriveToCommand.gs"
include "Schedule.gs"
//
// Driver schedule command used by DriveToCommand to get a driver character to take a train to
// a specific track on an industry.
//
class DriveToScheduleCommand isclass DriverScheduleCommand
{
public string industryName; // Name of the industry to drive to.
public string trackName; // Name of the track in the industry to drive to.
DriveToCommand parent;

//
//
//
public void SetParent(DriveToCommand newParent)
{
parent = newParent;
}

//
// Starts executing this schedule command on the given driver character.
//
public bool BeginExecute(DriverCharacter driver)
{
Train train = driver.GetTrain();
if (!train)
// cant drive if we dont have a train
return false;
Industry industry = cast<Industry>(Router.GetGameObject(industryName));
if (!industry)
// cant drive to an industry which doesn't exist
return false;
return driver.NavigateToIndustry(industry, trackName);
}

//
// we should really implement EndExecute() to allow the game to determine the success of this command
//

//
// Provides an icon for this command so it can be seen on the driver's schedule. Uses the industry
// icon to indicate the destination.
//
public object GetIcon(void)
{
Industry industry = cast<Industry>(Router.GetGameObject(industryName));
return cast<object>industry;
}

//
//
//
public string GetTooltip(void)
{
StringTable strTable = GetAsset().GetStringTable();
string userTrackName = trackName;
Industry industry = cast<Industry>(Router.GetGameObject(industryName));
if (industry)
{
string[] destNames = new string[0];
string[] destTracks = new string[0];
industry.AppendDriverDestinations(destNames,destTracks);
int i;
for (i = 0; i < destNames.size(); i++)
{
if (destTracks[i] == trackName)
{
userTrackName = destNames[i];
break;
}
}
}
return strTable.GetString("driver_command_drive_to") + industryName + " (" + userTrackName + ")";
}

//
//
//
public Soup GetProperties(void)
{
Soup soup = Constructors.NewSoup();
// Save support
// Save the properties to the soup, then return the soup
soup.SetNamedTag("industryName", industryName);
soup.SetNamedTag("trackName", trackName);
return soup;
}

//
//
//
public void SetProperties(Soup soup)
{
// Load support
// Setup the properties from the passed in soup
industryName = soup.GetNamedTag("industryName");
trackName = soup.GetNamedTag("trackName");
}
};

===Download this asset===
This asset is available for download from the TRS2006 website at:

Sorry, no download available.

A version of this asset is a ''built-in'' for TS2010, TS12.

==Return to CCG Index==
[[Content Creator's Guide]]

[[CCG/Kind_Examples|Kind Examples]]

CCG/DriverCommand

2025-02-15T12:22:44Z

Ek.skirl:

==KIND: DRIVERCOMMAND==

===Description===

A command for the train driver to accomplish a specific task.

===Container Structure===

A well formed drivercommand kind has the following container structure:

[[Image:CCG_drivercommand_dir.jpg]]

See Chapter 7 for an example asset of this kind. [??LINK??]

See Example [[CCG/Example:_DriverCommand|CCG Example DriverCommand]]

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

<font color="red">kind ''"drivercommand"''</font>
kuid ''kuid''
trainz-build ''data''
category-class ''data''
category-region ''data''
category-era ''data''
username ''data''
supports-null-driver-character ''data''
class ''data''
script ''data''
<font color="red">thumbnails</font>
{
<font color="green">0</font>
{
image ''file''
width ''data''
height ''data''
}
}

===TAGS AND CONTAINERS===

The following tags are further defined in Chapter 5:

;kuid
:Generated automatically by CCP.

;trainz-build
:Automatically set to 2.9 for 2009 assets.

;category-class
:Should be "YD" - Driver Command. See the "Maps & Scenarios" section of [[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.

;username
:Asset username. This will be the name that appears in the driver menu.

;kind
:Must be "drivercommand".

;class
:The name of the scenario class within the script file.

;script
:The script file (gs or gse file).

===Additional Tags===

;supports-null-driver-character
:Command can be executed without a driver present in the selected loco.

===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.

;TAGS
:kuid, trainz-build, category-class, category-region, category-era, username, kind, supports-null-driver-character, 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.

==Return to CCG Index==
[[Content Creator's Guide]]

2024-04-27T18:29:11Z

Ek.skirl: /* Calculating the frames the animation should move to */

==''Moving procedure for a container from one stack to another''==

This version uses meshes from a list of possible (prepared) containers. There are no queues or industrial parts, only asset instances and their meshes.

This process knows the necessary GOIDs and the necessary config container names:
==== 1. If the container to move is not the top container, break the task with error report====
The error returned should lead into tasks to shift the disturbing containers to other stacks.
==== 2. If the destination stack's top isn't free, break the task with error report====
The error returned should lead into tasks to shift the disturbing container to other stacks or to change the destination or to cancel the task.
==== 3. Move the crane parts to the container stack's top container to move====
This movement is visualized by animations of the carne's parented parts bridge, trolley, lift, rotor, gear and hooked meshes (GOID of the container stack is known).
==== 4. Hook the container to the gear====
Get the texture id of the container to move (GOID and fitting soups of the container are known).

Set the texture of the fitting invisible mesh of the gear to the fitting texture.

Make the fitting mesh visible (Mesh config container name is known).

Make the top container's mesh invisible (GOID and config mesh name is known).
Move the invisible top container to the destination stack's top (The GOID is known).
==== 5. Move the crane parts to the container's destination stack's top free position====
This movement is visualized by animations of the carne's parented parts bridge, trolley, lift, rotor, gear and hooked meshes (GOID of the container stack is known).
==== 6. Dehook the container from the gear====
Make the top container's mesh visible (GOID and config mesh name is known).

Make the fitting crane's mesh invisible (config container mesh name is known).

===Calculating the frames the animation should move to===
To calculate the destination frames we need the distance vector from the crane's frame zero location to the top of the container position at the stack. Since the location is used as WorldCoordinate and the stack and crane may reside in different baseboards, the first step is to "normalize" the baseboards. In the following this is agreed.

The crane's frame zero location is defined by the reacharea inset and will be calculated by containerStackTopWC minus craneOriginWC. The containerStackTopWC will be calculated by stackOriginWC plus stackPositionHeight. The stackPositionHeight is the sum of all stacked container's heights.

As moving speed in x, y, z direction of the crane parts we will use 5.4 km/h (~3.35 mi/s). Thus deltaFrameCount/1500 calculates the duration of the movement in seconds.

Now we are able to get the current frames list, the fromStack's frame list and the destStack's frame list to move the crane.

[[Category:ACTS]]

2024-04-24T15:44:04Z

Ek.skirl: Blanked the page