From 52d354f99e1e42bb9255b0d907703ad96ca11bbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Kis?= Date: Tue, 24 Jan 2023 17:03:32 +0100 Subject: [PATCH] Add notes into breakout boxes in sensor create tutorial. --- Docs/tuto_D_create_sensor.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/Docs/tuto_D_create_sensor.md b/Docs/tuto_D_create_sensor.md index 9a91f8c02..f258ccfb9 100644 --- a/Docs/tuto_D_create_sensor.md +++ b/Docs/tuto_D_create_sensor.md @@ -62,7 +62,10 @@ pipeline Object representing the data generated by the sensor. This is the object that will be passed to the final user, both in C++ and Python APIs. -> **Note**: To ensure best performance, sensors are registered and dispatched using a sort of "compile-time plugin system" based on template meta-programming. Most likely, the code won't compile until all the pieces are present. +!!! note + To ensure best performance, sensors are registered and dispatched using a + sort of "compile-time plugin system" based on template meta-programming. + Most likely, the code won't compile until all the pieces are present. --- ## Creating a new sensor @@ -246,7 +249,9 @@ void ASafeDistanceSensor::Set(const FActorDescription &Description) } ``` -> **Note**: The set function is called before UE4's `BeginPlay`, we won't use this virtual function here, but it's important for other sensors. +!!! note + The set function is called before UE4's `BeginPlay`, we won't use this + virtual function here, but it's important for other sensors. Now we're going to extend the box volume based on the bounding box of the actor that we're attached to. For that, the most convenient method is to use the @@ -285,7 +290,11 @@ void ASafeDistanceSensor::Tick(float DeltaSeconds) } ``` -> **Note**: In production-ready sensors, the `Tick` function should be very optimized, specially if the sensor sends big chunks of data. This function is called every update in the game thread thus significantly affects the performance of the simulator. +!!! note + In production-ready sensors, the `Tick` function should be very optimized, + specially if the sensor sends big chunks of data. This function is called + every update in the game thread thus significantly affects the performance + of the simulator. Ok, a couple of things going on here that we haven't mentioned yet, what's this stream?