Differences

This shows you the differences between two versions of the page.

--- qckpck2018:qckhud [2019/01/16 11:25] – [Background] lightwolf
+++ qckpck2018:qckhud [2019/06/03 13:03] (current) – lightwolf
@@ Line 13: / Line 13: @@
 ===== qckHuD Master Plugin =====
 Opening the master plugin displays a user interface to edit the overlays for the current scene. This user interface can be resized freely.
+{{ :qckpck2018:qckhud_gui.png |}}
+<-generic_qckpckcustom|^|^|->
 ==== Presets ====
+This uses the same presets system as our other plugins: [[exrtrader2018:presets|]]
 ==== About ====
 ==== List of Overlays ====
@@ Line 53: / Line 57: @@
 === Overlay ===
-This is the text displayed as an overlay. You may include any of the available variables to dynamically extract data from the current scene.
+This is the text displayed as an overlay. You may include any of the available [[#Variables]] to dynamically extract data from the current scene.
 === Hide if not used ===
@@ Line 61: / Line 65: @@
 === Append Variable... ===
-This appends and of the selected [[#Variables]] to the current overlay.
+This appends any of the selected [[#Variables]] to the current overlay.
+=== Append Item... ===
+This appends the selected item name as a variable limiter. See [[#Variables]] for more information.
 ==== Overlay Properties (right hand side) ====
@@ Line 113: / Line 121: @@
 === Enable ===
-En-/disables the background for the current position.
+En- / disables the background for the current position.
 === Colour ===
@@ Line 125: / Line 133: @@
 ===== Variables =====
-| **Scene** ||
+Variables need to be enclosed in % within the overlay, i.e.
+  Scene: %scene.name% - %scene.num_polygons% polygons
+Variables related to specific items can be limited to a specific item as opposed to the current selection.
+This is done by adding the item name in front of the variable, designated by a $, i.e.
+  $my_Camera%camera.zoom%
+If you actually want the characters % or $ to show up in an overlay, just type them twice. %% shows a single %, $$ a single $.
+<tabbox Scene>
 |scene.fps| Frames per second of the current scene|
 |scene.time| Time of the current frame in the scene in seconds|
@@ Line 139: / Line 157: @@
 |scene.num_polygons||
 |scene.render_camera||
-|**Item**||
+<tabbox Item>
 |item.name||
 |item.position|Position of the item in local coordinates. Append .x/.y/.z to display individual components|
 |item.rotation|Rotation of the item in local degrees. Append .h/.p/.b to display individual components|
-|item.scaling||
+|item.scaling|Scale of the item in local coordinates. Append .x/.y/.z to display individual components|
-|item.world_position||
+|item.world_position|World position of the item in local coordinates. Append .x/.y/.z to display individual components|
 |item.position_controller||
 |item.rotation_controller||
@@ Line 153: / Line 171: @@
 |item.goal||
 |item.breadcrumbs|The complete hierarchy of items to the selected item|
-|**Object**||
+<tabbox Object>
 |object.filename||
 |object.num_points||
 |object.num_polygons||
-|**Light**||
+<tabbox Light>
 |light.intensity||
 |light.type||
 |light.quality||
 |light.flags||
-|**Camera**||
+<tabbox Camera>
 |camera.zoom||
 |camera.focal_length||
@@ Line 168: / Line 187: @@
 |camera.f-stop||
 |camera.resolution||
-|**Bone**||
+<tabbox Bone>
 |bone.strength||
 |bone.twist||
@@ Line 178: / Line 198: @@
 |bone.limits|Minimum and Maximum rotation limits. Append .h/.p/.b to display individual components|
+</tabbox>
+If you think that any variables are missing to display the information you need, please get in touch with us and we’ll see if we can add them.