TNI Physics Interface - Revision history

Pw3r at 02:28, 16 February 2026

2026-02-16T02:28:42Z

← Older revision		Revision as of 02:28, 16 February 2026
Line 406:		Line 406:
	Basic accessors for TNIPhysicsVehicle member variables, including those on the frame data, engine spec or steam engine spec.		Basic accessors for TNIPhysicsVehicle member variables, including those on the frame data, engine spec or steam engine spec.

	==TNIGameObjectID/Matching Accessors==		===TNIGameObjectID/Matching Accessors===
	{{MethodHeader\|const TNIGameObjectID* TNIPhysicsGetVehicleID(const TNIPhysicsVehicle* vehicle)}}		{{MethodHeader\|const TNIGameObjectID* TNIPhysicsGetVehicleID(const TNIPhysicsVehicle* vehicle)}}
	{{MethodHeader\|const TNIGameObjectID* TNIPhysicsGetVehicleTrainID(const TNIPhysicsVehicle* vehicle)}}		{{MethodHeader\|const TNIGameObjectID* TNIPhysicsGetVehicleTrainID(const TNIPhysicsVehicle* vehicle)}}
Line 421:		Line 421:


	===~~AssetID/Config~~ Accessors===		===Train State Accessors===
	{{MethodHeader\|double TNIPhysicsGetTrainLocoCount(const TNIPhysicsVehicle* vehicle}}		{{MethodHeader\|double TNIPhysicsGetTrainLocoCount(const TNIPhysicsVehicle* vehicle}}

Pw3r at 02:27, 16 February 2026

2026-02-16T02:27:39Z

← Older revision		Revision as of 02:27, 16 February 2026
Line 405:		Line 405:
	==Accessor Commands (TNIPhysics.h)==		==Accessor Commands (TNIPhysics.h)==
	Basic accessors for TNIPhysicsVehicle member variables, including those on the frame data, engine spec or steam engine spec.		Basic accessors for TNIPhysicsVehicle member variables, including those on the frame data, engine spec or steam engine spec.

			==TNIGameObjectID/Matching Accessors==
			{{MethodHeader\|const TNIGameObjectID* TNIPhysicsGetVehicleID(const TNIPhysicsVehicle* vehicle)}}
			{{MethodHeader\|const TNIGameObjectID* TNIPhysicsGetVehicleTrainID(const TNIPhysicsVehicle* vehicle)}}
			{{MethodHeader\|bool TNIPhysicsDoesVehicleMatchID(const TNIPhysicsVehicle* vehicle, const TNIGameObjectID* id)}}


	===AssetID/Config Accessors===		===AssetID/Config Accessors===
Line 413:		Line 419:
	{{MethodHeader\|const TNIAssetID* TNIPhysicsGetVehicleTrackAssetID(const TNIPhysicsVehicle* vehicle)}}		{{MethodHeader\|const TNIAssetID* TNIPhysicsGetVehicleTrackAssetID(const TNIPhysicsVehicle* vehicle)}}
	{{MethodHeader\|const TNISoup* TNIPhysicsGetVehicleTrackAssetConfig(const TNIPhysicsVehicle* vehicle)}}		{{MethodHeader\|const TNISoup* TNIPhysicsGetVehicleTrackAssetConfig(const TNIPhysicsVehicle* vehicle)}}


			===AssetID/Config Accessors===
			{{MethodHeader\|double TNIPhysicsGetTrainLocoCount(const TNIPhysicsVehicle* vehicle}}


Line 432:		Line 442:
	{{MethodHeader\|float TNIPhysicsGetVehicleInjector2Setting(const TNIPhysicsVehicle* vehicle)}}		{{MethodHeader\|float TNIPhysicsGetVehicleInjector2Setting(const TNIPhysicsVehicle* vehicle)}}
	{{MethodHeader\|float TNIPhysicsGetVehicleBlowerSetting(const TNIPhysicsVehicle* vehicle)}}		{{MethodHeader\|float TNIPhysicsGetVehicleBlowerSetting(const TNIPhysicsVehicle* vehicle)}}
			{{MethodHeader\|float TNIPhysicsGetVehicleCustomSetting(const TNIPhysicsVehicle* vehicle, const TNILabel* settingName)}}

Pw3r at 01:59, 16 February 2026

2026-02-16T01:59:59Z

← Older revision		Revision as of 01:59, 16 February 2026
Line 108:		Line 108:
	*TNILabel - The name of the plugin function to execute. If the function name is unrecognised or unsupported, the plugin should log an error and ignore it. (The TNISoup param must still be read though, to avoid the command stream being corrupted.)		*TNILabel - The name of the plugin function to execute. If the function name is unrecognised or unsupported, the plugin should log an error and ignore it. (The TNISoup param must still be read though, to avoid the command stream being corrupted.)
	*TNISoup - An optional TNISoup to be included with the command. This is used to pass more parameters to the custom plugin function, where required. Parsing code must handle the possibility that the parameter is null, even if the extra parameters are not optional for the plugin code. Similarly, plugins must not make assumptions about the validity of the soup data, and should either appropriately handle all inputs or ignore the command entirely.		*TNISoup - An optional TNISoup to be included with the command. This is used to pass more parameters to the custom plugin function, where required. Parsing code must handle the possibility that the parameter is null, even if the extra parameters are not optional for the plugin code. Similarly, plugins must not make assumptions about the validity of the soup data, and should either appropriately handle all inputs or ignore the command entirely.



	==Outgoing Commands (TNIPhysicsGameCommand)==		==Outgoing Commands (TNIPhysicsGameCommand)==

Pw3r: /* Incoming Commands (TNIPhysicsPluginCommand) */

2026-02-16T01:59:28Z

Incoming Commands (TNIPhysicsPluginCommand)

← Older revision		Revision as of 01:59, 16 February 2026
Line 100:		Line 100:
	Parameters:		Parameters:
	*double - The volume (not mass) of coal to add.		*double - The volume (not mass) of coal to add.


			====TNIP_ScriptFunctionCall====
			Called from script to execute custom behaviour within the plugin. This will be added when a script calls Vehicle.LibraryCallPhysicsPlugin().

			Parameters:
			*TNILabel - The name of the plugin function to execute. If the function name is unrecognised or unsupported, the plugin should log an error and ignore it. (The TNISoup param must still be read though, to avoid the command stream being corrupted.)
			*TNISoup - An optional TNISoup to be included with the command. This is used to pass more parameters to the custom plugin function, where required. Parsing code must handle the possibility that the parameter is null, even if the extra parameters are not optional for the plugin code. Similarly, plugins must not make assumptions about the validity of the soup data, and should either appropriately handle all inputs or ignore the command entirely.

	==Outgoing Commands (TNIPhysicsGameCommand)==		==Outgoing Commands (TNIPhysicsGameCommand)==

Pw3r at 01:55, 16 February 2026

2026-02-16T01:55:24Z

← Older revision		Revision as of 01:55, 16 February 2026
Line 382:		Line 382:

	When this is called, the supplied feature list will completely replace any existing feature list. I.e. You must always provide the complete list of supported features for the current vehicle.		When this is called, the supplied feature list will completely replace any existing feature list. I.e. You must always provide the complete list of supported features for the current vehicle.


	====TNIP_ScriptPostMessage====		====TNIP_ScriptPostMessage====

Pw3r: /* TNIP_SetPluginFeatureSupport */

2026-02-16T01:54:35Z

TNIP_SetPluginFeatureSupport

← Older revision		Revision as of 01:54, 16 February 2026
Line 380:		Line 380:

	Note:		Note:

	When this is called, the supplied feature list will completely replace any existing feature list. I.e. You must always provide the complete list of supported features for the current vehicle.		When this is called, the supplied feature list will completely replace any existing feature list. I.e. You must always provide the complete list of supported features for the current vehicle.


	====TNIP_ScriptPostMessage====		====TNIP_ScriptPostMessage====

Pw3r at 01:53, 16 February 2026

2026-02-16T01:53:31Z

← Older revision		Revision as of 01:53, 16 February 2026
Line 389:		Line 389:
	*TNIString - The value to use for Message.minor. Must not be empty.		*TNIString - The value to use for Message.minor. Must not be empty.
	*TNISoup - An optional TNISoup to be included with the message. This allows custom data/parameters to be provided to script. This may be null but it must be written to avoid command stream corruption.		*TNISoup - An optional TNISoup to be included with the message. This allows custom data/parameters to be provided to script. This may be null but it must be written to avoid command stream corruption.



	==Accessor Commands (TNIPhysics.h)==		==Accessor Commands (TNIPhysics.h)==

Pw3r: /* Outgoing Commands (TNIPhysicsGameCommand) */

2026-02-16T01:52:48Z

Outgoing Commands (TNIPhysicsGameCommand)

@@ Line 102: / Line 102: @@
 ==Outgoing Commands (TNIPhysicsGameCommand)==
-The following describes rgw possible physics commands a plugin may issue to the game, as per <code>enum TNIPhysicsGameCommand</code>. A TNIPhysics plugin may write these commands (and their params) to the TNIStream being returned from a ProcessPhysicsCommands library call.
+The following describes the possible physics commands a plugin may issue to the game, as per <code>enum TNIPhysicsGameCommand</code>. A TNIPhysics plugin may write these commands (and their params) to the TNIStream being returned from a ProcessPhysicsCommands library call.
 ====TNIP_UpdateVehicleBegin====
@@ Line 369: / Line 369: @@
 *TNILabel - The name of the variable to update.
 *float - The new value of the variable.
 ==Accessor Commands (TNIPhysics.h)==

Pw3r: /* Incoming Commands (TNIPhysicsPluginCommand) */

2023-07-31T00:08:44Z

Incoming Commands (TNIPhysicsPluginCommand)

← Older revision		Revision as of 00:08, 31 July 2023
Line 83:		Line 83:

	====TNIP_SaveVehicleState====		====TNIP_SaveVehicleState====
	Called by Trainz code to request save data for a specific vehicle. If the plugin maintains any internal state for the specified vehicle then this function should save that state, so that players are able to save and reload with seamless physics behaviour. The save state should be returned to the game by adding a TNIP_ReturnSaveState command to the library call result stream (see TNIPhysicsGameCommand for more). If the plugin tracks no state for the vehicle passed, then this call can be safely ignored.		Called by Trainz code to request save data for a specific vehicle. If the plugin maintains any internal state for the specified vehicle then this function should save that state, so that players are able to save and reload with seamless physics behaviour. The save state should be returned to the game by adding a TNIP_ReturnSaveState command to the library call result stream (see TNIPhysicsGameCommand for more). If the plugin tracks no state for the vehicle passed, then this call can be safely ignored. That said, it is courteous to return known/common save data, even if this plugin itself may not use/require it, as it aids in seemless plugin switchover during gameplay.

	This command takes no parameters.		This command takes no parameters.
Line 93:		Line 93:
	Parameters:		Parameters:
	*TNISoup - A saved soup generated by a previous TNIP_SaveVehicleState call on this or another plugin. The soup will contain an AssetID param for the plugin that produced it, using the tag name "plugin-kuid".		*TNISoup - A saved soup generated by a previous TNIP_SaveVehicleState call on this or another plugin. The soup will contain an AssetID param for the plugin that produced it, using the tag name "plugin-kuid".


	====TNIP_SteamEngine_AddCoalToFire====		====TNIP_SteamEngine_AddCoalToFire====

Pw3r: /* Outgoing Commands (TNIPhysicsGameCommand) */

2023-07-31T00:06:02Z

Outgoing Commands (TNIPhysicsGameCommand)

← Older revision		Revision as of 00:06, 31 July 2023
Line 101:		Line 101:

	==Outgoing Commands (TNIPhysicsGameCommand)==		==Outgoing Commands (TNIPhysicsGameCommand)==
	~~Enumeration listing the~~ possible physics commands a plugin may issue to the game. A TNIPhysics plugin may write these commands (and their params) to the TNIStream returned by a ProcessPhysicsCommands library call.		The following describes rgw possible physics commands a plugin may issue to the game, as per <code>enum TNIPhysicsGameCommand</code>. A TNIPhysics plugin may write these commands (and their params) to the TNIStream being returned from a ProcessPhysicsCommands library call.

	====TNIP_UpdateVehicleBegin====		====TNIP_UpdateVehicleBegin====
Line 368:		Line 368:
	*TNILabel - The name of the variable to update.		*TNILabel - The name of the variable to update.
	*float - The new value of the variable.		*float - The new value of the variable.


	==Accessor Commands (TNIPhysics.h)==		==Accessor Commands (TNIPhysics.h)==