"mesh-table" container (interior version) - Revision history

Gdennish: /* mousespeed */

2020-06-17T02:59:55Z

mousespeed

← Older revision		Revision as of 02:59, 17 June 2020
Line 186:		Line 186:
	====mousespeed====		====mousespeed====
	:Type: Float		:Type: Float
	:Desc: Controls the mouse speed and push/pull direction for controls. '''''Do not use zero'''''.		:Desc: Controls the mouse speed and push/pull direction for controls. The higher the number, the less effort is required by the user to move the lever to another notch. '''''Do not use zero'''''.
	:Examples of use:		:Examples of use:
	:* mousespeed -1 Inverts mouse direction.		:* mousespeed -1 - ''Inverts mouse direction.''
	:* mousespeed 2 Doubles mouse speed in default direction.		:* mousespeed 2 - ''Doubles mouse speed in default direction.''
	:* mousespeed -0.5 Inverts mouse direction and halves the speed.		:* mousespeed -0.5 - ''Inverts mouse direction and halves the speed.''
	:* mousespeed 10 Multiplies the mouse speed tenfold in default direction. Useful for smaller levers that require too much mouse movement to activate the lever.		:* mousespeed 10 - ''Multiplies the mouse speed tenfold in default direction. Useful for smaller levers that require too much mouse movement to activate the lever.''

	====notches====		====notches====

Gdennish: /* notchheight */

2020-06-17T02:55:31Z

notchheight

← Older revision		Revision as of 02:55, 17 June 2020
Line 206:		Line 206:
	:* '3' configures this bar to be standard length, but thicker in width. This is often used for marking a specific position.		:* '3' configures this bar to be standard length, but thicker in width. This is often used for marking a specific position.

	'''A kind ''lever'' type will not function unless notch heights are specified.'''		:Notes: '''A kind ''lever'' type will not function unless notch heights are specified.'''

	====onlight====		====onlight====

Gdennish: /* notches */

2020-06-17T02:54:58Z

notches

← Older revision		Revision as of 02:54, 17 June 2020
Line 196:		Line 196:
	:Type: Decimal List		:Type: Decimal List
	:Desc: Specifies the positions of the notches for this control. Notches are discrete positions within the movement of the control where the lever can be stopped. If a lever does not have notches, it can be positioned at any location. There are two common uses for notches. Firstly, they can be used to define a control which has a number of discrete positions which mean specific things (e.g. a brake valve). Secondly, they are used to define pre-set discrete values that a control can provide (e.g. a throttle lever). A typical US diesel 8 notch throttle would have something like "notches 0.0,0.125,0.25,0.375,0.5,0.625,0.75,0.875,1.0", specifying nine positions (for 'off' and notches 1 thru 8).		:Desc: Specifies the positions of the notches for this control. Notches are discrete positions within the movement of the control where the lever can be stopped. If a lever does not have notches, it can be positioned at any location. There are two common uses for notches. Firstly, they can be used to define a control which has a number of discrete positions which mean specific things (e.g. a brake valve). Secondly, they are used to define pre-set discrete values that a control can provide (e.g. a throttle lever). A typical US diesel 8 notch throttle would have something like "notches 0.0,0.125,0.25,0.375,0.5,0.625,0.75,0.875,1.0", specifying nine positions (for 'off' and notches 1 thru 8).
			:Notes: When using notches, the tag ''notchheight'' must be used otherwise the lever will not function and spring back to the original position.

	====notchheight====		====notchheight====

Gdennish: /* notchheight */

2020-06-17T02:50:49Z

notchheight

← Older revision		Revision as of 02:50, 17 June 2020
Line 204:		Line 204:
	:* '2' configures this bar to be shorter in length, and is often used for intermediate positions.		:* '2' configures this bar to be shorter in length, and is often used for intermediate positions.
	:* '3' configures this bar to be standard length, but thicker in width. This is often used for marking a specific position.		:* '3' configures this bar to be standard length, but thicker in width. This is often used for marking a specific position.

			'''A kind ''lever'' type will not function unless notch heights are specified.'''

	====onlight====		====onlight====

Gdennish: /* mousespeed */

2020-06-16T23:34:15Z

mousespeed

← Older revision		Revision as of 23:34, 16 June 2020
Line 191:		Line 191:
	:* mousespeed 2 Doubles mouse speed in default direction.		:* mousespeed 2 Doubles mouse speed in default direction.
	:* mousespeed -0.5 Inverts mouse direction and halves the speed.		:* mousespeed -0.5 Inverts mouse direction and halves the speed.
			:* mousespeed 10 Multiplies the mouse speed tenfold in default direction. Useful for smaller levers that require too much mouse movement to activate the lever.

	====notches====		====notches====

Gdennish: Added more entries to the Steam cabin entries and organized by lever and needle type.

2020-06-10T20:39:59Z

Added more entries to the Steam cabin entries and organized by lever and needle type.

← Older revision		Revision as of 20:39, 10 June 2020
Line 7:		Line 7:
	There are a number of standard mesh names that the trainz default cab script uses for it's controls. For a Diesel or Electric cab (either unscripted, or scripted and inheriting from the DefaultLocomotiveCabin class), the following are the default mesh names:		There are a number of standard mesh names that the trainz default cab script uses for it's controls. For a Diesel or Electric cab (either unscripted, or scripted and inheriting from the DefaultLocomotiveCabin class), the following are the default mesh names:

			'''Needles:'''
	* speedo_needle -- speedometer		* speedo_needle -- speedometer
	* speedo_needle2 -- speedometer		* speedo_needle2 -- speedometer
Line 20:		Line 21:
	* ampmeter_needle -- traction ammeter gauge		* ampmeter_needle -- traction ammeter gauge
	* ampmeter2_needle -- traction ammeter gauge		* ampmeter2_needle -- traction ammeter gauge

			'''Levers:'''

	* throttle_lever -- throttle lever control		* throttle_lever -- throttle lever control
	* reverser_lever -- reverser lever control		* reverser_lever -- reverser lever control
Line 33:		Line 37:
	* bell -- bell control		* bell -- bell control
	For a Steam cab (either unscripted, or scripted and inheriting from the DefaultSteamCabin class), these default mesh names are available:		For a Steam cab (either unscripted, or scripted and inheriting from the DefaultSteamCabin class), these default mesh names are available:

			'''Needles:'''

	* speedo_needle -- speedometer		* speedo_needle -- speedometer
Line 42:		Line 48:
	* bploco_equaliser -- brake equaliser pressure gauge		* bploco_equaliser -- brake equaliser pressure gauge
	* flow_needle -- brake flow rate gauge		* flow_needle -- brake flow rate gauge
			* boiler_needle -- boiler pressure
			* boiler_needle1 -- boiler pressure
			* steam_chest_needle -- steam chest pressure

			'''Levers:'''

	* trainbrake_lever -- self-lapping train brake control		* trainbrake_lever -- self-lapping train brake control
	* trainbrakelap_lever -- non self-lapping train brake control		* trainbrakelap_lever -- non self-lapping train brake control
Line 49:		Line 61:
	* waterglass_left -- boiler water level		* waterglass_left -- boiler water level
	* waterglass_right -- boiler water level		* waterglass_right -- boiler water level
	* firebox -- the interior of the firebox (to show fire temperature)		* firebox -- the interior of the firebox (to show fire temperature) Only works pre-TANE.
	* boiler_needle -~~- boiler pressure~~
	* boiler_needle1 -- boiler pressure
	* steam_chest_needle -- steam chest pressure
	* regulator -- regulator (throttle) control		* regulator -- regulator (throttle) control
	* reverser -- cutoff (reverser) control		* reverser -- cutoff (reverser) control
Line 61:		Line 70:
	* sanding_lever -- locomotive sander control		* sanding_lever -- locomotive sander control
	* blowdown_lever -- blowdown control (releases water out of the boiler)		* blowdown_lever -- blowdown control (releases water out of the boiler)
			* bell -- bell control
			* left_window -- Left window control
			* right_window -- Right window control
			* left_sliding_window-- Left sliding window control
			* right_sliding_window-- Right sliding window control
			* seat0 -- Seat control
			* seat1 -- Seat control
			* whistle_lever -- Whistle lever control. (Doesn't seem to actually control the horn, so the whistle lever should actually be called "horn" to function properly."

	=Supported Tags=		=Supported Tags=

Gdennish: /* Standard Mesh Names */

2019-11-02T04:45:45Z

Standard Mesh Names

← Older revision		Revision as of 04:45, 2 November 2019
Line 31:		Line 31:
	* pantograph_lever -- pantograph control		* pantograph_lever -- pantograph control
	* throttle_brake_lever -- combined throttle/self-lapping brake lever		* throttle_brake_lever -- combined throttle/self-lapping brake lever
			* bell -- bell control
	For a Steam cab (either unscripted, or scripted and inheriting from the DefaultSteamCabin class), these default mesh names are available:		For a Steam cab (either unscripted, or scripted and inheriting from the DefaultSteamCabin class), these default mesh names are available:

Line 61:		Line 61:
	* sanding_lever -- locomotive sander control		* sanding_lever -- locomotive sander control
	* blowdown_lever -- blowdown control (releases water out of the boiler)		* blowdown_lever -- blowdown control (releases water out of the boiler)



	=Supported Tags=		=Supported Tags=

Pw3r at 05:50, 8 August 2019

2019-08-08T05:50:55Z

← Older revision		Revision as of 05:50, 8 August 2019
Line 69:		Line 69:
	tooltip-text ""		tooltip-text ""
	tooltip-token ""		tooltip-token ""
			tooltip-mesh ""
	limits 0,1		limits 0,1
	angles 0,0		angles 0,0
Line 191:		Line 192:
	:Type: String		:Type: String
	:Desc: Specify the name of a ''light'' kind mesh which is enabled when this switch/lever is in the ''on'' position, and disabled when it is in the ''off'' position. The mesh name must be in the mesh-table. See the example below.		:Desc: Specify the name of a ''light'' kind mesh which is enabled when this switch/lever is in the ''on'' position, and disabled when it is in the ''off'' position. The mesh name must be in the mesh-table. See the example below.

			====radius====
			:Type: Decimal
			:Desc: Specifies the distance for the 2D notch overlay.

			====tooltip-mesh====
			:Type: String
			:Desc: Specifies the name of a mesh-table entry for a mesh to show when the control is moused over. The mesh will be faded in/out over a short period.

	====tooltip-text====		====tooltip-text====
Line 198:		Line 207:
	====tooltip-token====		====tooltip-token====
	:Type: String		:Type: String
	:Desc: The name of a string table entry. The contents of the named string table entry will be displayed as a tooltip that appears when the mouse cursor hovers over a cab control. If a token is used then it must appear as a tag in the [[%22String-table%22 container]] .		:Desc: The name of a string table entry. The contents of the named string table entry will be displayed as a tooltip that appears when the mouse cursor hovers over a cab control. If a token is used then it must appear as a tag in the [[%22String-table%22 container]].

	====value====		====value====
Line 204:		Line 213:
	:Desc: Specifies the initial value for this control. For a lever or other input device, this will specify the initial position of the control before the user moves it.		:Desc: Specifies the initial value for this control. For a lever or other input device, this will specify the initial position of the control before the user moves it.

	~~====radius====~~
	~~:Type: Decimal~~
	~~:Desc: Specifies the distance for the 2D notch overlay.~~

	=Cab Interior Mesh-Table Example=		=Cab Interior Mesh-Table Example=

Gdennish: /* Supported Tags */

2019-06-19T01:08:36Z

Supported Tags

← Older revision		Revision as of 01:08, 19 June 2019
Line 204:		Line 204:
	:Desc: Specifies the initial value for this control. For a lever or other input device, this will specify the initial position of the control before the user moves it.		:Desc: Specifies the initial value for this control. For a lever or other input device, this will specify the initial position of the control before the user moves it.

			====radius====
			:Type: Decimal
			:Desc: Specifies the distance for the 2D notch overlay.

	=Cab Interior Mesh-Table Example=		=Cab Interior Mesh-Table Example=

Builderbob: String table

2018-05-08T01:04:00Z

String table

← Older revision		Revision as of 01:04, 8 May 2018
Line 198:		Line 198:
	====tooltip-token====		====tooltip-token====
	:Type: String		:Type: String
	:Desc: The name of a string table entry. The contents of the named string table entry will be displayed as a tooltip that appears when the mouse cursor hovers over a cab control.		:Desc: The name of a string table entry. The contents of the named string table entry will be displayed as a tooltip that appears when the mouse cursor hovers over a cab control. If a token is used then it must appear as a tag in the [[%22String-table%22 container]] .

	====value====		====value====