TrainzScript Keywords - Revision history

Jonies: Fix The bThreadRunning status

2025-08-08T08:23:17Z

Fix The bThreadRunning status

← Older revision		Revision as of 08:23, 8 August 2025
Line 304:		Line 304:
	}		}

	bThreadRunning = ~~true~~;		bThreadRunning = false;
	}		}

Pw3r at 22:45, 20 March 2025

2025-03-20T22:45:31Z

← Older revision		Revision as of 22:45, 20 March 2025
Line 188:		Line 188:
	*A function with the legacy_compatibility keyword will not generate compiler warnings about obsolete function usages.		*A function with the legacy_compatibility keyword will not generate compiler warnings about obsolete function usages.
	*legacy_compatibility functions are most commonly used to load and upgrade legacy data formats.		*legacy_compatibility functions are most commonly used to load and upgrade legacy data formats.
			*Added at trainz-build 5.0
	*See also: [[#obsolete\|obsolete]]		*See also: [[#obsolete\|obsolete]]
	<br>		<br>

Pw3r at 01:11, 3 March 2022

2022-03-03T01:11:56Z

← Older revision		Revision as of 01:11, 3 March 2022
Line 62:		Line 62:
	{{MethodHeader\|<h4>class</h4>}}		{{MethodHeader\|<h4>class</h4>}}
	*Class defines a new class declaration and the identity of the immediate parent:		*Class defines a new class declaration and the identity of the immediate parent:
	class ChildClass isclass ParentClass {		class ChildClass isclass ParentClass
			{

	class members...		class members...
Line 241:		Line 242:
	public string forename; // Public member variable		public string forename; // Public member variable
	public string surname; // Public member variable		public string surname; // Public member variable

	// Public function		// Public function
	public string GetName(void)		public string GetName(void)

Pw3r at 01:10, 3 March 2022

2022-03-03T01:10:46Z

Show changes

Pw3r at 00:54, 3 March 2022

2022-03-03T00:54:08Z

← Older revision		Revision as of 00:54, 3 March 2022
Line 4:		Line 4:
	** [[Operators]]		** [[Operators]]
	** [[Types]]		** [[Types]]

	<br />		<br />

	==Keywords==		==Keywords==
	~~__NOEDITSECTION__~~
	{{MethodHeader\|<h4>break</h4>}}		{{MethodHeader\|<h4>break</h4>}}
	*Exits from current code block (''[[#for\|for]], [[#wait\|wait]], [[#switch\|switch]], [[#while\|while]]'')		*Exits from current code block (''[[#for\|for]], [[#wait\|wait]], [[#switch\|switch]], [[#while\|while]]'')
Line 163:		Line 160:
	*inherited() returns the same type, and takes the same parameters as the parent method.		*inherited() returns the same type, and takes the same parameters as the parent method.
	*Inheritance is central to Object Oriented Programming, you should not omit these calls.		*Inheritance is central to Object Oriented Programming, you should not omit these calls.
			<br>

			{{MethodHeader\|<h4>legacy_compatibility</h4>}}
			*The legacy_compatibility keyword indicates that a specific function exists in order to support legacy usage only.
			*A function with the legacy_compatibility keyword will not generate compiler warnings about obsolete function usages.
			*legacy_compatibility functions are most commonly used to load and upgrade legacy data formats.
			*See also: [[#obsolete\|obsolete]]
	<br>		<br>

Line 171:		Line 175:
	{{MethodHeader\|<h4>me</h4>}}		{{MethodHeader\|<h4>me</h4>}}
	*me refers to the current object, similar to ''self'' or ''this'' keywords in other languages.		*me refers to the current object, similar to ''self'' or ''this'' keywords in other languages.
			*me is used to overcome ambiguity of variable scope, or use the current object as a function parameter.
	*me is often understood if not stated, these statements would have the same effect:		*me is often understood if not stated, these statements would have the same effect:
	me.SetMeshAnimationState();		me.SetMeshAnimationState();
Line 177:		Line 182:

	{{MethodHeader\|<h4>native</h4>}}		{{MethodHeader\|<h4>native</h4>}}
	*A method specifier which indicates that the method is implemented by the ~~game~~ rather than in script code.		*A method specifier which indicates that the method is implemented by the games "native code" rather than in script code.
	<br>		<br>

Line 183:		Line 188:
	*null is an uninitialised expression.		*null is an uninitialised expression.
	*Every reference that is not assigned to an object has the value null.		*Every reference that is not assigned to an object has the value null.
	*Assigning null to an existing object will ~~delete the~~ reference to that object.		*Assigning null to an existing object will remove that reference to that object. When no references remain, the object will be deleted.
			<br>

			{{MethodHeader\|<h4>obsolete</h4>}}
			*Indicates that the function is obsolete and should not be used.
			*Obsolete functions may not operate and/or generate errors in certain [[Compatibility_mode\|Compatibility mode settings]].
			*Some functions are marked obsolete because their features are not supported, but many will have modern replacements.
			*See also: [[#legacy_compatibility\|legacy_compatibility]]
	<br>		<br>

Line 191:		Line 203:

	{{MethodHeader\|<h4>public</h4>}}		{{MethodHeader\|<h4>public</h4>}}
	*A specifier indicating that the member or method is accessible ~~from outside the current class~~.		*A specifier indicating that the member or method is accessible by other classes.
	<br>		<br>

Line 204:		Line 216:
	*Static classes cannot be created using the new operator.		*Static classes cannot be created using the new operator.
	*To access a static class refer to its members or methods using the class name as follows:		*To access a static class refer to its members or methods using the class name as follows:
	static class ~~owner {~~		static class Owner
			{
	public string forename; // ~~public~~ member		public string forename; // Public member variable
	public string surname; // ~~public~~ member		public string surname; // Public member variable
	public string GetName(void) { ~~// public method~~
	return forename + " " + surname;		// Public function
			public string GetName(void)
			{
			return forename + " " + surname;
	}		}

	};		};

	class ~~postbox~~ isclass MapObject {		class Postbox isclass MapObject
			{
	public void Init(void) {		public void Init(void)
	if (!~~owner~~.forename) ~~owner~~.forename = "Fred";		{
	if (!~~owner~~.surname) ~~owner~~.surname = "Bloggs";		if (!Owner.forename)
	Interface.Print(~~owner~~.GetName());		Owner.forename = "Fred";
			if (!Owner.surname)
			Owner.surname = "Bloggs";
			Interface.Print(Owner.GetName());
	}		}

	}		}

	*Since only one instance of owner may exist it will be created along with the first instance of the postbox obect		*Since only one instance of owner may exist it will be created along with the first instance of the postbox obect
	*Any future postboxes will find the members of the owner class already initialised and ready for use.		*Any future postboxes will find the members of the owner class already initialised and ready for use.

Danny252: Add links between language reference pages

2020-12-28T14:09:00Z

Add links between language reference pages

← Older revision		Revision as of 14:09, 28 December 2020
Line 1:		Line 1:
			* [[TrainzScript Language Reference]]
			** [[Comments & Delineation]]
			** [[TrainzScript Keywords]]
			** [[Operators]]
			** [[Types]]

			<br />

	==Keywords==		==Keywords==
	__NOEDITSECTION__		__NOEDITSECTION__

Builderbob: Categories

2019-04-24T00:51:37Z

Windwalkr: Windwalkr moved page Keywords to TrainzScript Keywords

2016-05-11T06:28:44Z

Windwalkr moved page Keywords to TrainzScript Keywords

← Older revision	Revision as of 06:28, 11 May 2016
(No difference)

Andi06 at 14:45, 4 October 2015

2015-10-04T14:45:33Z

← Older revision		Revision as of 14:45, 4 October 2015
Line 155:		Line 155:
	*inherited() returns the same type, and takes the same parameters as the parent method.		*inherited() returns the same type, and takes the same parameters as the parent method.
	*Inheritance is central to Object Oriented Programming, you should not omit these calls.		*Inheritance is central to Object Oriented Programming, you should not omit these calls.
			<br>

			{{MethodHeader\|<h4>mandatory</h4>}}
			*mandatory is a method specifier which indicates that, if the method is over-ridden the over-ridden method '''must''' call ''inherited''.
	<br>		<br>

Windwalkr: 1 revision

2010-02-03T13:59:19Z

1 revision

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

← Older revision		Revision as of 00:51, 24 April 2019
Line 296:		Line 296:
	}		}
	<br>		<br>


			=Categories=
			[[Category:TrainzScript]]