Class Industry

Revision as of 02:20, 10 February 2010 (view source) Windwalkr (Talk | contribs) m ← Older edit		Latest revision as of 10:05, 4 October 2023 (view source) Pw3r (Talk | contribs) (→‎Methods)
(One intermediate revision by one user not shown)
Line 1:		Line 1:
−	*[[TrainzScript Language Reference|API Hierarchy]]	+	*[[TrainzScript Library Reference|API Hierarchy]]
	**[[Class GSObject|GSObject]] *		**[[Class GSObject|GSObject]] *
	***[[Class GameObject|GameObject]]		***[[Class GameObject|GameObject]]
Line 48:		Line 48:
	===AppendDriverDestinations===		===AppendDriverDestinations===
−	{{MethodHeader|public void AppendDriverDestinations(string[ ] destNames, string[ ] destTracks)}}	+	{{MethodHeader|public void AppendDriverDestinations(string[] destNames, string[] destTracks)}}
	;Parameters		;Parameters
−	*'''destNames''' = An array of names of destinations to be displayed in a menu.	+	*'''destNames''' = OUTPUT - An array of localised and human-readable track names. See StringTable.gs for details on how to support localisation.
−	*'''destTracks''' = An array of attached-track names as defined in the Industry's ''config.txt''	+	*'''destTracks''' = OUTPUT - An array of machine-readable track names, as specified in the industry asset config file.
−	*The array size of these two parameters must contain the same number of entries.	+
	;Returned Value		;Returned Value
	*None		*None
	;Syntax		;Syntax
−	AppendDriverDestinations(Str.Tokens("Bay 1,Bay 2",","),Str.Tokens("track01,track02",","));	+	string[] localisedNames = new string[0];
		+	string[] destinationNames = new string[0];
		+	AppendDriverDestinations(localisedNames, destinationNames);
	;Notes		;Notes
	*Provides destinations for use of this industry on the Drive To sub-menu.		*Provides destinations for use of this industry on the Drive To sub-menu.
Line 64:		Line 65:
	*The indexes of each these arrays must correspond.		*The indexes of each these arrays must correspond.
	*You don't have to worry about allocating memory for the arrays as Trainzscript expands the array size automatically if this is necessary.		*You don't have to worry about allocating memory for the arrays as Trainzscript expands the array size automatically if this is necessary.
		+	<br>
		+
		+	===AppendDriverDestinations===
		+	{{MethodHeader|public void AppendDriverDestinations(Asset product, bool bIsForUnloading, string[] destNames, string[] destTracks)}}
		+	;Parameters
		+	*'''product''' = A product asset that the caller wants to load/unload.
		+	*'''bIsForUnloading''' = Specifies whether the caller wants deliver/unload the product (true) or pickup/load it (false).
		+	*'''destNames''' = OUTPUT - An array of localised and human-readable track names. See StringTable.gs for details on how to support localisation.
		+	*'''destTracks''' = OUTPUT - An array of machine-readable track names, as specified in the industry asset config file.
		+	;Returned Value
		+	*Whether the function is implemented. This function should only return false if the scripter has not implemented it at all. If the the function is implemented to ever return any destination tracks (for any product), then it should always return true.
		+	;Syntax
		+	string[] localisedNames = new string[0];
		+	string[] destinationNames = new string[0];
		+	AppendDriverDestinations(desiredProduct, desiredLoadUnloadAction, localisedNames, destinationNames);
		+	;Notes
		+	*Functions as per the original AppendDriverDestinations variant (detailed above), but filters the returned list to a specific product and load/unload action.
		+	*Required to correctly support Living Railroad load/unload at multi-track industries.
	<br>		<br>

---

Latest revision as of 10:05, 4 October 2023

• API Hierarchy
  • GSObject *
    • GameObject
      • TrainzGameObject
      • PropertyObject *
        • MeshObject
          • MapObject
            • SceneryWithTrack
              • Buildable
                • Industry

• Parent class for industry objects.
• Industries support attached tracks and triggers and processes.
• The methods include support for the transfer of products to ad from vehicles.

Contents 1 Constants & Messages 1.1 Load and Unload Driver Command Strings 1.2 Related Messages 2 Methods 2.1 AppendDriverDestinations 2.2 AppendDriverDestinations 2.3 AppendProductList 2.4 BeginLoad 2.5 BeginUnload 2.6 ClearProcess 2.7 CreateLoadingReport 2.8 CreateUnloadingReport 2.9 EndLoad 2.10 EndUnload 2.11 GetLoadTime 2.12 GetProcessDuration 2.13 GetProcessEnabled 2.14 GetProcessInput 2.15 GetProcessIOAmount 2.16 GetProcessIOProduct 2.17 GetProcessIOQueue 2.18 GetProcessNameList 2.19 GetProcessOutput 2.20 GetProcessStarted 2.21 GetRequirements 2.22 GetUnloadTime 2.23 HandleTrain 2.24 HasTrack 2.25 NotifyProcessFinished 2.26 NotifyProcessStarted 2.27 PerformProcessCancelled 2.28 PerformProcessFinished 2.29 PerformProcessInput 2.30 PerformProcessOutput 2.31 PerformProcessStarted 2.32 SetProcessDuration 2.33 SetProcessEnabled 2.34 SetProcessInput 2.35 SetProcessOutput 3 Code Examples 4 Related Methods 5 Categories

[edit] Constants & Messages

[edit] Load and Unload Driver Command Strings

• These values indicate the type of command calling HandleTrain().

public define string LOAD_COMMAND = "load"	Driver command Load
public define string UNLOAD_COMMAND = "unload"	Driver command Unload

[edit] Related Messages

• Messages sent to and from Industry objects are listed below:

Major	Minor	Source	Destination
Process-Start	process name	Industry	Industry
Process-Stop	process name	Industry	Industry
HandleTrain	Release	Industry	Train
Vehicle	LoadComplete	Industry	Vehicle

• See also Object Messages for details of messages exchanged between Vehicles and attached triggers.

[edit] Methods

[edit] AppendDriverDestinations

Parameters

• destNames = OUTPUT - An array of localised and human-readable track names. See StringTable.gs for details on how to support localisation.
• destTracks = OUTPUT - An array of machine-readable track names, as specified in the industry asset config file.

Returned Value

• None

Syntax

string[] localisedNames = new string[0];
string[] destinationNames = new string[0];
AppendDriverDestinations(localisedNames, destinationNames);

Notes

• Provides destinations for use of this industry on the Drive To sub-menu.
• If the programmer wants the appropriate destinations to appear in the Drive To command's menus, this method must be implemented.
• A user readable name and the name of the actual destination track must be provided.
• Two arrays are passed in as return arguments, one for the readable names and the other for the track names.
• The indexes of each these arrays must correspond.
• You don't have to worry about allocating memory for the arrays as Trainzscript expands the array size automatically if this is necessary.

[edit] AppendDriverDestinations

Parameters

• product = A product asset that the caller wants to load/unload.
• bIsForUnloading = Specifies whether the caller wants deliver/unload the product (true) or pickup/load it (false).
• destNames = OUTPUT - An array of localised and human-readable track names. See StringTable.gs for details on how to support localisation.
• destTracks = OUTPUT - An array of machine-readable track names, as specified in the industry asset config file.

Returned Value

• Whether the function is implemented. This function should only return false if the scripter has not implemented it at all. If the the function is implemented to ever return any destination tracks (for any product), then it should always return true.

Syntax

string[] localisedNames = new string[0];
string[] destinationNames = new string[0];
AppendDriverDestinations(desiredProduct, desiredLoadUnloadAction, localisedNames, destinationNames);

Notes

• Functions as per the original AppendDriverDestinations variant (detailed above), but filters the returned list to a specific product and load/unload action.
• Required to correctly support Living Railroad load/unload at multi-track industries.

[edit] AppendProductList

Parameters

• productList = Asset array to which products will be added.

Returned Value

• None

Syntax

AppendProductList(assets);

Notes

• Adds all of the products that the industry is currently capable of producing to the given asset array.
• Check that the given products are not already present before calling this method.

[edit] BeginLoad

Parameters

• report = Report on the current state of the loading operation.

Returned Value

• The time required, in seconds, for any animations or other effects required before the loading operation commences.

Notes

• Callback method called by Vehicle.LoadProduct() before carrying out any loading operation.

[edit] BeginUnload

Parameters

• report = Report on the current state of the loading operation.

Returned Value

• The time required, in seconds, for any animations or other effects required before the unloading operation commences.

Notes

• Callback method called by Vehicle.UnloadProduct() before carrying out any unloading operation.

[edit] ClearProcess

Parameters

• processName = Name of the process to reset.

Returned Value

• None

Syntax

ClearProcess("timberProduction");

Notes

• Clears all current inputs and outputs for the named process.

[edit] CreateLoadingReport

Parameters

• queue = Industry source queue.
• amount = Quantity of product to load.

Returned Value

• A newly created LoadingReport object describing the loading operation.

Syntax

LoadingReport report = CreateLoadingReport("brickstore",5000);

Notes

• This method creates 'documentation' but doesn't actually perform the operation.

[edit] CreateUnloadingReport

Parameters

• queue = Industry source queue.
• amount = Quantity of product to unload.

Returned Value

• A newly created LoadingReport object describing the unloading operation.

Syntax

LoadingReport report = CreateUnloadingReport("deliveries",5000);

Notes

• This method creates 'documentation' but doesn't actually perform the operation.

[edit] EndLoad

Parameters

• report = Report on the current state of the loading operation.

Returned Value

• The time required, in seconds, for any animations or other effects required after the loading operation is completed.

Notes

• Callback method called by Vehicle.LoadProduct() after carrying out any loading operation.

[edit] EndUnload

Parameters

• report = Report on the current state of the unloading operation.

Returned Value

• The time required, in seconds, for any animations or other effects required after the unloading operation is completed.

Notes

• Callback method called by Vehicle.UnloadProduct() after carrying out any unloading operation.

[edit] GetLoadTime

Parameters

• report = Report on the current state of the loading operation.

Returned Value

• The time required, in seconds, for the loading operation to take place.

Notes

• Callback method called by Vehicle.LoadProduct() to detemine the time needed for the loading operation.

[edit] GetProcessDuration

Parameters

• processName = The name of the process to query.

Returned Value

• The duration of the named process in seconds.

Syntax

float processTime = GetProcessDuration("outputProcess");

Notes

[edit] GetProcessEnabled

Parameters

• processName = The name of the process to query.

Returned Value

• True if the specified process is enabled, false otherwise.

Syntax

bool canProcess = GetProcessEnabled("outputProcess");

Notes

[edit] GetProcessInput

Parameters

• processName = The name of the process to query.
• queue = Name of the input queue.
• product = Type of product being processed.

Returned Value

• The unit quantity of products consumed by this process from the specified queue during one process cycle.

Syntax

int input = GetProcessInput("processName",queue,product);

Notes

[edit] GetProcessIOAmount

Parameters

• processName = Name of the process to query.
• wantInput = True for an input queue, false for an output queue.
• ioIndex = Index of the input or output queue to query, use 0 for the first queue defined.

Returned Value

• The quantity of product produced or consumed by the specified process during one product cycle, 0 if the information cannot be established.

Syntax

int consumption = GetProcessIOAmount("input",true,0);

Notes

[edit] GetProcessIOProduct

Parameters

• processName = Name of the process to query.
• wantInput = True for an input queue, false for an output queue.
• ioIndex = Index of the input or output queue to query, use 0 for the first queue defined.

Returned Value

• The product for the specified process if possible, null otherwise.

Syntax

Asset product = GetProcessIOProduct("input",true,0);

Notes

[edit] GetProcessIOQueue

Parameters

• processName = Name of the process to query.
• wantInput = True for an input queue, false for an output queue.
• ioIndex = Index of the input or output queue to query, use 0 for the first queue defined.

Returned Value

• The queue related to the specified process if possible, null otherwise.

Syntax

ProductQueue queue = GetProcessIOProduct("input",true,0);

Notes

[edit] GetProcessNameList

Parameters

• None

Returned Value

• The names of all the processes associated with this Industry object.

Syntax

string[] processes = GetProcessNameList();

Notes

[edit] GetProcessOutput

Parameters

• processName = The name of the process to query.
• queue = Name of the output queue.
• product = Type of product being processed.

Returned Value

• The unit quantity of products produced by this process from the specified queue during one process cycle.

Syntax

int output = GetProcessOutput("processName",queue,product);

Notes

[edit] GetProcessStarted

Parameters

• processName = The name of the process to query.

Returned Value

• True if the named process has started, false otherwise.

Syntax

bool hasStarted = GetProcessStarted("production");

Notes

[edit] GetRequirements

Parameters

• None

Returned Value

• An array of Requirements to enable a waybill listing to be produced.

Notes

• A callback method which returns an empty array by default.
• This method is called by Trainz to determine the product requirements of an industry so that a waybill listing can be generated for display.
• The default implementation in Industry returns an empty array, so the programmer must implement their own overridden version if they want their industry to provide requirements data for waybills.

[edit] GetUnloadTime

Parameters

• report = Report on the current state of the unloading operation.

Returned Value

• The time required, in seconds, for the unloading operation to take place.

Notes

• Callback method called by Vehicle.UnloadProduct() to detemine the time needed for the unloading operation.

[edit] HandleTrain

Parameters

• None
• train = Train to be controlled through the industry.
• loadCommand = Either of the Load and Unload Driver Command String constants indicating a load or unload command.

Returned Value

• True if successful or if the operation is handled by another thread, false on failure. The default implementation always returns false.

Notes

• Called by the Load and Unload driver commands to initiate loading or unloading.
• The method is called from within a schedule and is permitted to control the train, but not to perform loading or unloading.

[edit] HasTrack

Parameters

• trackName = Name of attached track section.

Returned Value

• True if trackName exists in this Industry, false otherwise.

Syntax

bool IsCoalmine = industry.HasTrack("pithead");

Notes

[edit] NotifyProcessFinished

Parameters

• processName = Name of the process.

Returned Value

• None

Notes

• Called by Trainz once when a process is ready to stop running.
• You may override this function to provide custom behavior, however, you MUST call the PerformProcessOutput() and PerformProcessFinished() methods.
• The call to these methods may be delayed for animation purposes, but it must happen.
• As this is not a threaded function, you must not use Sleep() or wait().

[edit] NotifyProcessStarted

Parameters

• processName = Name of the process.

Returned Value

• None

Notes

• Called by Trainz once when a process is ready to start.
• You may override this function to provide custom behavior, however, you MUST call the PerformProcessInput() and PerformProcessStarted() methods.
• The call to these methods may be delayed for animation purposes, but it must happen.
• As this is not a threaded function, you must not use Sleep() or wait().

[edit] PerformProcessCancelled

Parameters

• processName = Name of the process to cancel.

Returned Value

• None

Syntax

PerformProcessCancelled("production");

Notes

• Instructs Trainz to cancel the named process.

[edit] PerformProcessFinished

Parameters

• processName = Name of the process.

Returned Value

• None

Syntax

PerformProcessFinished("production");

Notes

• Instructs Trainz to complete the named process.

[edit] PerformProcessInput

Parameters

• processName = Name of the process.

Returned Value

• True if successful, false otherwise.

Syntax

PerformProcessInput("input");

Notes

• Instructs Trainz to perform inputs for the named process.
• This method should be called once only after each call to NotifyProcessStarted(), unless PerformProcessCancelled() is called first.

[edit] PerformProcessOutput

Parameters

• processName = Name of the process.

Returned Value

• True if successful, false otherwise.

Syntax

PerformProcessOutput("output");

Notes

• Instructs Trainz to perform outputs for the named process.
• This method should be called once only after each call to NotifyProcessStarted(), unless PerformProcessCancelled() is called first.

[edit] PerformProcessStarted

Parameters

• processName = Name of the process.

Returned Value

• None

Syntax

PerformProcessStarted("production");

Notes

• Instructs Trainz to start the named process.

[edit] SetProcessDuration

Parameters

• processName = Name of the process.
• duration = New duration for the named process, in seconds.

Returned Value

• None

Syntax

SetProcessDuration("input",25.0);

Notes

[edit] SetProcessEnabled

Parameters

• processName = Name of the process.
• enabled = True to enable the process, false to disable.

Returned Value

• None

Syntax

SetProcessEnabled("input",true);

Notes

[edit] SetProcessInput

Parameters

• processName = Name of the process.
• queue = Input queue to adjust.
• product = Product type to accept as new input into queue.
• amount = Quantity of product per process cycle, 0 will remove input requirements.

Returned Value

• None

Syntax

SetProcessInput("input",inputQueue,product,50);

Notes

• Modifies the input requirements for the specified process.
• Using this method will override any existing requirements for the process, whether they have been set previously via this method or predefined in the industry's configuration.

[edit] SetProcessOutput

Parameters

• processName = Name of the process.
• queue = Output queue to adjust.
• product = Product type to accept as new input into queue.
• amount = Quantity of product per process cycle, 0 will remove output requirements.

Returned Value

• None

Syntax

SetProcessOutput("input",outputQueue,product,50);

Notes

• Modifies the output requirements for the specified process.
• Using this method will override any existing requirements for the process, whether they have been set previously via this method or predefined in the industry's configuration.

[edit] Code Examples

[edit] Related Methods

[edit] Categories