MSFS Mission Script - Triggers - Revision history

BASys: Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024

2024-05-25T17:29:12Z

Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024

← Older revision		Revision as of 12:29, 25 May 2024
Line 2:		Line 2:
	{{:Ambox-Content-WIP}}		{{:Ambox-Content-WIP}}
	{{Infobox-Applicable-FSVersion		{{Infobox-Applicable-FSVersion
	\| ~~MSFS~~ = true		\| MSFS2024 = unknown
			\| MSFS2020 = true
	\| FSXI = false		\| FSXI = false
	\| P3D5 = false		\| P3D5 = false

Mr LiamT: /* InputActionTrigger */ Add explanation

2022-01-04T13:34:27Z

InputActionTrigger: Add explanation

← Older revision		Revision as of 08:34, 4 January 2022
Line 52:		Line 52:
	Provides GUI billboard menu and executes the mission actions for the chosen item. Not yet implemented in MSFS.		Provides GUI billboard menu and executes the mission actions for the chosen item. Not yet implemented in MSFS.
	==== InputActionTrigger ====		==== InputActionTrigger ====
	When active, wait for inputs to be triggered (e.g., keypress, joystick button).		When active, wait for inputs to be triggered (e.g., keypress, joystick button, gear down binding).

	==== ValidatedChecklistStepTrigger ====		==== ValidatedChecklistStepTrigger ====
	Fires when a specific checklist step is all validated.		Fires when a specific checklist step is all validated.

Mr LiamT: /* EventTrigger */ Add event explanation

2021-12-06T12:55:08Z

EventTrigger: Add event explanation

← Older revision		Revision as of 07:55, 6 December 2021
Line 80:		Line 80:
	== [[MSFS_Mission_Script_-_Events\|Event]] ==		== [[MSFS_Mission_Script_-_Events\|Event]] ==
	==== EventTrigger ====		==== EventTrigger ====
			Events are text popups you can put on the screen.

	== [[MSFS Mission Script - Flow states\|Flowstate]] ==		== [[MSFS Mission Script - Flow states\|Flowstate]] ==

Mr LiamT: /* ProximityTrigger */ Add WhileInside explanation

2021-12-06T12:08:54Z

ProximityTrigger: Add WhileInside explanation

← Older revision		Revision as of 07:08, 6 December 2021
Line 69:		Line 69:

	==== [[Proximity Trigger\|ProximityTrigger]] ====		==== [[Proximity Trigger\|ProximityTrigger]] ====
	Fires when objects enters or exits an area.		Fires when objects enters or exits an area, or checks if an object is currently inside.

	==== CollisionTrigger ====		==== CollisionTrigger ====
	Fires when user collides with the given object(s).		Fires when user collides with the given object(s).

Mr LiamT: /* PropertyTrigger */ Add Simvar explanation

2021-12-06T12:07:57Z

PropertyTrigger: Add Simvar explanation

← Older revision		Revision as of 07:07, 6 December 2021
Line 66:		Line 66:
	Detects landings on a runway or in an area.		Detects landings on a runway or in an area.
	==== [[Property Trigger\|PropertyTrigger]] ====		==== [[Property Trigger\|PropertyTrigger]] ====
	A propertytrigger is a very useful trigger. It can be used for instance to fire when the users' plane reaches a specific altitude or speed.		A propertytrigger is a very useful trigger. The trigger can take in Simvars to create a condition for firing. It can be used for instance to fire when the users' plane reaches a specific altitude or speed.

	==== [[Proximity Trigger\|ProximityTrigger]] ====		==== [[Proximity Trigger\|ProximityTrigger]] ====
	Fires when objects enters or exits an area.		Fires when objects enters or exits an area.

Mr LiamT: /* FlowEventTrigger */

2021-11-23T13:55:30Z

FlowEventTrigger

← Older revision		Revision as of 08:55, 23 November 2021
Line 81:		Line 81:
	== [[MSFS Mission Script - Flow states\|Flowstate]] ==		== [[MSFS Mission Script - Flow states\|Flowstate]] ==
	==== FlowEventTrigger ====		==== FlowEventTrigger ====
	Triggers when a flow event is fired		Triggers when a certain flow event is fired.

	==== TimerTriggerFlowStateAction ====		==== TimerTriggerFlowStateAction ====
	See: [[MSFS Mission Script - Flow states]].		See: [[MSFS Mission Script - Flow states]].

Mr LiamT: /* OnSpawnTrigger */ Add explanation

2021-11-23T13:54:32Z

OnSpawnTrigger: Add explanation

← Older revision		Revision as of 08:54, 23 November 2021
Line 103:		Line 103:
	A to B waypoint		A to B waypoint
	==== OnSpawnTrigger ====		==== OnSpawnTrigger ====
			Fires when the player's plane is spawned during loading. This allows you to do some things before the loading has ended. For example fire an [[MSFS_Mission_Script_-_Actions#RTCLocationsPreloadAction\|RTCLocationsPreloadAction]].

	==== OnEndLoadingTrigger ====		==== OnEndLoadingTrigger ====
	==== AssistanceTrigger ====		==== AssistanceTrigger ====

Mr LiamT: /* EventTrigger */ Removed duplicate link

2021-11-20T14:55:11Z

EventTrigger: Removed duplicate link

← Older revision		Revision as of 09:55, 20 November 2021
Line 78:		Line 78:
	== [[MSFS_Mission_Script_-_Events\|Event]] ==		== [[MSFS_Mission_Script_-_Events\|Event]] ==
	==== EventTrigger ====		==== EventTrigger ====
	~~See: [[MSFS Mission Script - Events]].~~

	== [[MSFS Mission Script - Flow states\|Flowstate]] ==		== [[MSFS Mission Script - Flow states\|Flowstate]] ==

Mr LiamT: /* Event */ Added link to events page

2021-11-20T14:54:55Z

Event: Added link to events page

← Older revision		Revision as of 09:54, 20 November 2021
Line 76:		Line 76:
	Fires when the user parks in the ATC-designated spot		Fires when the user parks in the ATC-designated spot

	== Event ==		== [[MSFS_Mission_Script_-_Events\|Event]] ==
	==== EventTrigger ====		==== EventTrigger ====
	See: [[MSFS Mission Script - Events]].		See: [[MSFS Mission Script - Events]].

Mr LiamT: Added missing triggers, changed categorisation, and added descriptions to most triggers

2021-11-20T14:53:04Z

Added missing triggers, changed categorisation, and added descriptions to most triggers

← Older revision		Revision as of 09:53, 20 November 2021
Line 1:		Line 1:
	[[Category:MSFS_Mission_Script]]		[[Category:MSFS_Mission_Script]]

	{{:Ambox-Content-WIP}}		{{:Ambox-Content-WIP}}

	{{Infobox-Applicable-FSVersion		{{Infobox-Applicable-FSVersion
	\| MSFS = true		\| MSFS = true
Line 21:		Line 19:
	\| XP9 = false		\| XP9 = false
	}}		}}
	Triggers fire when a condition is met. When a trigger fires, the actions referenced in the ObjectReferenceList are played. {{:Transclusion_MSFS_Mission_Script}}		Triggers fire when a condition is met. When a trigger fires, the actions referenced in the ObjectReferenceList are played.
			{{:Transclusion_MSFS_Mission_Script}}

	== General attributes ==		== General attributes ==
Line 27:		Line 26:
	=== Activated ===		=== Activated ===
	If a trigger is activated it will wait for its condition is met and it can fire. You may not want the trigger to be active at the start of the mission. If you want the trigger to be disabled at the start you should uncheck this property. You can change it throughout the mission with an ObjectActivationAction.		If a trigger is activated it will wait for its condition is met and it can fire. You may not want the trigger to be active at the start of the mission. If you want the trigger to be disabled at the start you should uncheck this property. You can change it throughout the mission with an ObjectActivationAction.

	=== DefaultActivated ===		=== DefaultActivated ===
	Usage unknown.		Usage unknown.

	=== OneShot ===		=== OneShot ===
	If this property is set to true, a trigger will only fire once. You can change a trigger to be able to fire again and again by unchecking the OneShot property.		If this property is set to true, a trigger will only fire once. You can change a trigger to be able to fire again and again by unchecking the OneShot property.

	=== Latched ===		=== Latched ===
	When a trigger is latched it means it has fired and will never fire again. This happens when a OneShot trigger fires. When that happens, the Latched property is automatically set to True. You shouldn’t change this property in the script editor.		When a trigger is latched it means it has fired and will never fire again. This happens when a OneShot trigger fires. When that happens, the Latched property is automatically set to True. You shouldn’t change this property in the script editor.
			:''You can use a Property trigger to check to see if another trigger is “latched.” This is useful in cases where you want to give the user an award after they’ve completed one or multiple parts of a mission.''
	You can use a Property trigger to check to see if another trigger is “latched.” This is useful in cases where you want to give the user an award after they’ve completed one or multiple parts of a mission.

	=== OnScreenTimer ===		=== OnScreenTimer ===
	You can choose a trigger with a timer element to be the onscreen timer, but it is unclear how to actually display this in msfs.		You can choose a trigger with a timer element to be the onscreen timer, but it is unclear how to actually display this in msfs.

	=== IsGlobal ===		=== IsGlobal ===
	In multiplayer missions, triggers with the IsGlobal property set to True will affect all other players. Probably doesn't work in MSFS.		In multiplayer missions, triggers with the IsGlobal property set to True will affect all other players. Probably doesn't work in MSFS.

	== ~~Common triggers~~==		== Mission logic ==
	==== [[~~Landing~~ Trigger\|~~AirportLandingTrigger & AreaLandingTrigger~~]] ====		==== [[Timer Trigger\|TimerTrigger]] ====
	~~Detects landings on~~ a ~~runway or~~ in ~~an area~~.		A timer trigger is a very useful trigger that waits a specified number of seconds before executing actions. It is often used to start the first actions in the mission.
	==== [[Counter Trigger\|CounterTrigger]] ====		==== [[Counter Trigger\|CounterTrigger]] ====
	Has a counter that can be changed by a [[CountAction]]. It fires when a specific count has been reached.		Has a counter that can be changed by a [[CountAction]]. It fires when a specific count has been reached.
			==== TriggersFiredTrigger ====
			Triggers when all triggers in list fired at least once.
			==== TimelineAction ====
			Start a timer and execute actions at specific times.

			== Player ==
			==== MenuPromptTrigger ====
			Provides GUI billboard menu and executes the mission actions for the chosen item. Not yet implemented in MSFS.
			==== InputActionTrigger ====
			When active, wait for inputs to be triggered (e.g., keypress, joystick button).
			==== ValidatedChecklistStepTrigger ====
			Fires when a specific checklist step is all validated.
			==== ObjectInteractionTrigger ====
			Fires when interacting with object
			==== CockpitInteractionTrigger ====
			Fires when the users interacts with a cockpit element.
			==== CameraTargetTrigger ====
			Trigger that fires when in camera frustum. So when it is in the boundaries of the camera, but it can be behind something else.

			== Plane ==
			==== [[Landing Trigger\|AirportLandingTrigger & AreaLandingTrigger]] ====
			Detects landings on a runway or in an area.
	==== [[Property Trigger\|PropertyTrigger]] ====		==== [[Property Trigger\|PropertyTrigger]] ====
	A propertytrigger is a very useful trigger. It can be used for instance to fire when the users' plane reaches a specific altitude or speed.		A propertytrigger is a very useful trigger. It can be used for instance to fire when the users' plane reaches a specific altitude or speed.
	==== [[Proximity Trigger\|ProximityTrigger]] ====		==== [[Proximity Trigger\|ProximityTrigger]] ====
	~~A proximity trigger fires~~ when objects enters or exits an area.		Fires when objects enters or exits an area.
	==== ~~[[Timer Trigger\|TimerTrigger]]~~ ====		==== CollisionTrigger ====
	~~A timer trigger is a very useful trigger that waits a specified number~~ of ~~seconds before executing actions~~. ~~It is often used to start~~ the ~~first actions~~ in the ~~mission.~~		Fires when user collides with the given object(s).
			==== ProgressiveTaxiTrigger ====
			Fires at the end of progressive taxi.
			==== ParkingTrigger ====
			Fires when the user parks in the ATC-designated spot

	== Event ==		== Event ==
Line 62:		Line 80:
	See: [[MSFS Mission Script - Events]].		See: [[MSFS Mission Script - Events]].

	== Flowstate ==		== [[MSFS Mission Script - Flow states\|Flowstate]] ==
	==== FlowEventTrigger ====		==== FlowEventTrigger ====
			Triggers when a flow event is fired
	==== TimerTriggerFlowStateAction ====		==== TimerTriggerFlowStateAction ====
	See: [[MSFS Mission Script - Flow states]].		See: [[MSFS Mission Script - Flow states]].

	== ~~Untested triggers~~ ==		== Race ==
			==== RaceEndTrigger ====
			Fires when local user completes the race (not necessarily when race is declared over).
			==== LastLapTrigger ====
			Fires when local user starts the last lap of the race.

			== Other ==
	==== AnimationEventTrigger ====		==== AnimationEventTrigger ====
			When active, wait for an animationEvent before executing actions.
			==== EndAnimationTrigger ====
			Fires when an animation is over.
	==== CameraEventTrigger ====		==== CameraEventTrigger ====
	==== ~~CollisionTrigger~~ ====		When active, wait for an cameraEvent before executing actions.
	==== ~~LastLapTrigger~~ ====		==== EndRTCTrigger ====
	~~==== MenuPromptTrigger ====~~		Triggers when the [[RTC (MSFS)\|RTC]] ends.
	==== ~~ObjectInteractionTrigger~~ ====		==== AtoB_SphereWPTrigger ====
	==== ~~ParkingTrigger~~ ====		A to B waypoint
	==== ~~RaceEndTrigger~~ ====		==== OnSpawnTrigger ====
			==== OnEndLoadingTrigger ====
			==== AssistanceTrigger ====
	==== NodeDistanceTrigger ====		==== NodeDistanceTrigger ====
	~~==== AssistanceTrigger ====~~


	{{Template:Navbox-Mission-Creation-MSFS}}		{{Template:Navbox-Mission-Creation-MSFS}}