From e62c15cdad63765d14d4cc57acc0058f9d47cb4f Mon Sep 17 00:00:00 2001 From: Julian Smith Date: Sun, 24 Oct 2021 11:23:21 +0100 Subject: [PATCH] docs-mini/README-mp-carriers.md: new, info about auto-attach and latch-always. --- docs-mini/README-mp-carriers.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs-mini/README-mp-carriers.md diff --git a/docs-mini/README-mp-carriers.md b/docs-mini/README-mp-carriers.md new file mode 100644 index 000000000..3b526ff37 --- /dev/null +++ b/docs-mini/README-mp-carriers.md @@ -0,0 +1,26 @@ +# MP carriers + +[TOC] + +## Overview + +There are two settings properties that improve the behaviour of MP carriers. + +Both appear in the "Multiplayer Settings" dialogue, from menu "Multiplayer/Multiplayer Settings". + +* `/sim/mp-carriers/auto-attach` + + This is true by default. + + When an MP carriers appear, we automatically enable the matching AI scenerio so that it will + be visible to the user. + +* `/sim/mp-carriers/latch-always` + + This is not enabled by default. + + When enabled we force an AI carrier to exactly follow the position and orientation of the MP carrier; this is done by C++ in each frame (otherwise Flightgear uses Nasal to periodically change the AI carrier's velocity to make it approximately follow the MP carrier). + + This works better as long as multiplayer motion is smooth (e.g. with simple-time). + + And it also improves behaviour when replaying recordings because the carrier position is replayed exactly the same as when recorded.