Danny252: Change link to library reference, not language reference

2020-12-28T13:44:20Z

Change link to library reference, not language reference

← Older revision		Revision as of 13:44, 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:19, 9 February 2010

2010-02-09T16:19:57Z

← Older revision		Revision as of 16:19, 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:33Z

1 revision

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

Andi06 at 21:41, 31 July 2008

2008-07-31T21:41:59Z

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]]
********Buildable
 

*Parent class for industry objects.
*In older versions Buildable contained attached track and trigger methods now located in [[Class SceneryWithTrack|SceneryWithTrack]]
*Methods currently included were intended for RTS-style gameplay where individual industries start in an unbuilt state and can be built at some resource cost during gameplay.
*These have not been widely used.
 

==Constants & Messages==

===Buildable Object States===
*These values define the current state of the Buildable object.
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int STATE_POTENTIAL = 0 ||Object has potential to build.
|-
|public define int STATE_BUILDING = 1 ||Construction is in progress.
|-
|public define int STATE_COMPLETE = 2 ||Construction is complete.
|}
 

===Related Messages===
*Messages sent to and from Buildable objects are listed below:
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Build||Started||--||Buildable
|-
|Build||Cancelled||--||Buildable
|-
|Build||Completed||--||Buildable
|}
 

==Methods==

===CancelBuild===
{{MethodHeader|public native bool CancelBuild(void)}}
*Cancel construction.
;Parameters
*None
;Returned Value
*True to indicate success.
 

===EnableUserCancelBuild===
{{MethodHeader|public native void EnableUserCancelBuild(bool enable)}}
*Allow the user to cancel construction.
;Parameters:
*'''enable''' = If true, the user will be able to cancel the build.
;Returned Value
*None
 

===EnableUserStartBuild===
{{MethodHeader|public native void EnableUserStartBuild(bool enable)}}
*Allow the user to commence construction.
;Parameters:
*'''enable''' = If true, the user will be able to commence the build.
;Returned Value
*None
 

===GetBuildingProgress===
{{MethodHeader|public native float GetBuildingProgress(void)}}
*Gets the current progress of this buildable object.
;Parameters
*None
;Returned Value
*Current progress of the building.
 

===GetBuildingState===
{{MethodHeader|public native int GetBuildingState(void)}}
*Gets the current state of this buildable object.
;Parameters
*None
;Returned Value
*The current state of this object, one of the [[#Buildable Object States|Buildable Object States]].
 

===SetBuildingPaused===
{{MethodHeader|public native void SetBuildingPaused(bool paused)}}
*Pauses or restarts construction.
;Parameters:
*'''paused''' = if true, construction will be paused.
;Returned Value
*None
 

===SetBuildingProgress===
{{MethodHeader|public native void SetBuildingProgress(float progress)}}
*Sets the progress rate of this building
;Parameters
*'''progress''' = Rate of progress of the building.
;Returned Value
*None
 

===SetBuildingState===
{{MethodHeader|public native void SetBuildingState(int state)}}
*Sets the state of this buildable object.
;Parameters:
*'''state''' = The state of this object, one of the [[#Buildable Object States|Buildable Object States]].
;Returned Value
*None
 

===StartBuild===
{{MethodHeader|public native bool StartBuild(void)}}
*Starts building.
;Parameters
*None
;Returned Value
*True if construction started, false otherwise.
 

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

Class Buildable - Revision history

Danny252: Change link to library reference, not language reference

Windwalkr at 16:19, 9 February 2010

Windwalkr: 1 revision

Andi06 at 21:41, 31 July 2008