Pw3r: /* Methods */

2023-10-04T00:05:56Z

Methods

← Older revision		Revision as of 00:05, 4 October 2023
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>

Danny252: Change link to library reference, not language reference

2020-12-28T13:41:59Z

Change link to library reference, not language reference

← Older revision		Revision as of 13:41, 28 December 2020
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]]

Windwalkr at 16:20, 9 February 2010

2010-02-09T16:20:36Z

← Older revision		Revision as of 16:20, 9 February 2010
Line 1:		Line 1:
	*[[TrainzScript ~~Langage~~ Reference\|API Hierarchy]]		*[[TrainzScript Language Reference\|API Hierarchy]]
	*[[Class GSObject\|GSObject]]		*[[Class GSObject\|GSObject]]
	***[[Class GameObject\|GameObject]]		***[[Class GameObject\|GameObject]]

Windwalkr: 1 revision

2010-02-03T13:58:35Z

1 revision

← Older revision	Revision as of 13:58, 3 February 2010
(No difference)

Andi06 at 00:23, 9 August 2008

2008-08-09T00:23:05Z

New page

*[[TrainzScript Langage Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******[[Class SceneryWithTrack|SceneryWithTrack]]
********[[Class Buildable|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.
 

==Constants & Messages==

===Load and Unload Driver Command Strings===
*These values indicate the type of command calling HandleTrain().
{{TableHeader|width=95%|margin=15px}}
|width=375|public define string LOAD_COMMAND = "load"||Driver command ''Load''
|-
|public define string UNLOAD_COMMAND = "unload"||Driver command ''Unload''
|}
 

===Related Messages===
*Messages sent to and from Industry objects are listed below:
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''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.
 

==Methods==

===AppendDriverDestinations===
{{MethodHeader|public void AppendDriverDestinations(string[ ] destNames, string[ ] destTracks)}}
;Parameters
*'''destNames''' = An array of names of destinations to be displayed in a menu.
*'''destTracks''' = An array of attached-track names as defined in the Industry's ''config.txt''
*The array size of these two parameters must contain the same number of entries.
;Returned Value
*None
;Syntax
AppendDriverDestinations(Str.Tokens("Bay 1,Bay 2",","),Str.Tokens("track01,track02",","));
;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.
 

===AppendProductList===
{{MethodHeader|public void AppendProductList(Asset[ ] productList)}}
;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.
 

===BeginLoad===
{{MethodHeader|public float BeginLoad(LoadingReport report)}}
;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 [[Class Vehicle#LoadProduct|Vehicle.LoadProduct()]] before carrying out any loading operation.
 

===BeginUnload===
{{MethodHeader|public float BeginUnload(LoadingReport report)}}
;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 [[Class Vehicle#UnloadProduct|Vehicle.UnloadProduct()]] before carrying out any unloading operation.
 

===ClearProcess===
{{MethodHeader|public native void ClearProcess(string processName)}}
;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.
 

===CreateLoadingReport===
{{MethodHeader|public LoadingReport CreateLoadingReport(ProductQueue queue, int amount)}}
;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.
 

===CreateUnloadingReport===
{{MethodHeader|public LoadingReport CreateUnloadingReport(ProductQueue queue, int amount)}}
;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.
 

===EndLoad===
{{MethodHeader|public float EndLoad(LoadingReport report)}}
;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 [[Class Vehicle#LoadProduct|Vehicle.LoadProduct()]] after carrying out any loading operation.
 

===EndUnload===
{{MethodHeader|public float EndUnload(LoadingReport report)}}
;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 [[Class Vehicle#UnloadProduct|Vehicle.UnloadProduct()]] after carrying out any unloading operation.
 

===GetLoadTime===
{{MethodHeader|public float GetLoadTime(LoadingReport report)}}
;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 [[Class Vehicle#LoadProduct|Vehicle.LoadProduct()]] to detemine the time needed for the loading operation.
 

===GetProcessDuration===
{{MethodHeader|public native float GetProcessDuration(string processName)}}
;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
 

===GetProcessEnabled===
{{MethodHeader|public native bool GetProcessEnabled(string processName)}}
;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
 

===GetProcessInput===
{{MethodHeader|public native int GetProcessInput(string processName, ProductQueue queue, Asset product)}}
;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
 

===GetProcessIOAmount===
{{MethodHeader|public native int GetProcessIOAmount(string processName, bool wantInput, int ioIndex)}}
;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
 

===GetProcessIOProduct===
{{MethodHeader|public native Asset GetProcessIOProduct(string processName, bool wantInput, int ioIndex)}}
;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
 

===GetProcessIOQueue===
{{MethodHeader|public native ProductQueue GetProcessIOQueue(string processName, bool wantInput, int ioIndex)}}
;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
 

===GetProcessNameList===
{{MethodHeader|public native string[ ] GetProcessNameList(void)}}
;Parameters
*None
;Returned Value
*The names of all the processes associated with this Industry object.
;Syntax
string[] processes = GetProcessNameList();
;Notes
 

===GetProcessOutput===
{{MethodHeader|public native int GetProcessOutput(string processName, ProductQueue queue, Asset product)}}
;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
 

===GetProcessStarted===
{{MethodHeader|public native bool GetProcessStarted(string processName)}}
;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
 

===GetRequirements===
{{MethodHeader|public Requirement[ ] GetRequirements(void)}}
;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.
 

===GetUnloadTime===
{{MethodHeader|public float GetUnloadTime(LoadingReport report)}}
;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 [[Class Vehicle#UnloadProduct|Vehicle.UnloadProduct()]] to detemine the time needed for the unloading operation.
 

===HandleTrain===
{{MethodHeader|public bool HandleTrain(Train train, string loadCommand)}}
;Parameters
*None
*'''train''' = Train to be controlled through the industry.
*'''loadCommand''' = Either of the [[#Load and Unload Driver Command Strings|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.
 

===HasTrack===
{{MethodHeader|public bool HasTrack(string trackName)}}
;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
 

===NotifyProcessFinished===
{{MethodHeader|public void NotifyProcessFinished(string processName)}}
;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|PerformProcessOutput()]] and [[#PerformProcessFinished|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().
 

===NotifyProcessStarted===
{{MethodHeader|NotifyProcessStarted(string processName)}}
;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|PerformProcessInput()]] and [[#PerformProcessStarted|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().
 

===PerformProcessCancelled===
{{MethodHeader|public native void PerformProcessCancelled(string processName)}}
;Parameters
*'''processName''' = Name of the process to cancel.
;Returned Value
*None
;Syntax
PerformProcessCancelled("production");
;Notes
*Instructs Trainz to cancel the named process.
 

===PerformProcessFinished===
{{MethodHeader|PerformProcessFinished(string processName)}}
;Parameters
*'''processName''' = Name of the process.
;Returned Value
*None
;Syntax
PerformProcessFinished("production");
;Notes
*Instructs Trainz to complete the named process.
 

===PerformProcessInput===
{{MethodHeader|public native bool PerformProcessInput(string processName)}}
;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|NotifyProcessStarted()]], unless [[#PerformProcessCancelled|PerformProcessCancelled()]] is called first.
 

===PerformProcessOutput===
{{MethodHeader|public native bool PerformProcessOutput(string processName)}}
;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|NotifyProcessStarted()]], unless [[#PerformProcessCancelled|PerformProcessCancelled()]] is called first.
 

===PerformProcessStarted===
{{MethodHeader|PerformProcessStarted(string processName)}}
;Parameters
*'''processName''' = Name of the process.
;Returned Value
*None
;Syntax
PerformProcessStarted("production");
;Notes
*Instructs Trainz to start the named process.
 

===SetProcessDuration===
{{MethodHeader|public native void SetProcessDuration(string processName, float duration)}}
;Parameters
*'''processName''' = Name of the process.
*'''duration''' = New duration for the named process, in seconds.
;Returned Value
*None
;Syntax
SetProcessDuration("input",25.0);
;Notes
 

===SetProcessEnabled===
{{MethodHeader|public native void SetProcessEnabled(string processName, bool enabled)}}
;Parameters
*'''processName''' = Name of the process.
*'''enabled''' = True to enable the process, false to disable.
;Returned Value
*None
;Syntax
SetProcessEnabled("input",true);
;Notes
 

===SetProcessInput===
{{MethodHeader|public native void SetProcessInput(string processName, ProductQueue queue, Asset product, int amount)}}
;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.
 

===SetProcessOutput===
{{MethodHeader|public native void SetProcessOutput(string processName, ProductQueue queue, Asset product, int amount)}}
;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.
 

==Code Examples==
 

==Related Methods==
 

==Categories==
[[Category:Script Class]]

Class Industry - Revision history

Pw3r: /* Methods */

Danny252: Change link to library reference, not language reference

Windwalkr at 16:20, 9 February 2010

Windwalkr: 1 revision

Andi06 at 00:23, 9 August 2008