From 1eac5156bfcb868493058d4464822cd4a5e686b2 Mon Sep 17 00:00:00 2001
From: drian <drian0@protonmail.com>
Date: Thu, 15 Apr 2021 10:27:37 +0200
Subject: [PATCH] #61 added documentation for clean edit mode

---
 config/docs.cfg    | 14 ++++++++++++++
 docs/reference.xml | 21 +++++++++++++++++++++
 2 files changed, 35 insertions(+)

diff --git a/config/docs.cfg b/config/docs.cfg
index d206e2fa..faee5ed0 100644
--- a/config/docs.cfg
+++ b/config/docs.cfg
@@ -3132,6 +3132,16 @@ docident [calcmipstats] [Counts all the mips in the current map and prints their
 
 docref [showmip];
 
+docident [cleanedit] [Turns on/off clean edit mode.];
+
+docargument [V] [sets cleanedit on/off] [0 (off), 1 (on)] [0];
+
+docremark [While editing in clean edit mode, objects/guides not normally visible remain invisible.];
+
+docremark [i.e. The grid guidelines, selection borders, entity sparkles, clips, playerstart arrows are hidden];
+
+docref [togglecleanedit];
+
 docident [clearents] [Deletes all entities of said type.];
 
 docargument [T] [the entity type, see command 'newent'] [string] [0];
@@ -5024,6 +5034,10 @@ docref [deletetextureslot];
 
 docref [edittexturestack];
 
+docident [togglecleanedit] [Inverses the on/off state of cleanedit];
+
+docref [cleanedit];
+
 docident [toggleclosestentpin] [Toggles the pin on the "closest entity" selector.];
 
 docremark [The HUD will indicate the lock by showing "pinned" instead of "closest" entity. All actions, that would otherwise affect the closest entity, will affect the pinned entity instead. Deleting the locked entity will unlock it.];
diff --git a/docs/reference.xml b/docs/reference.xml
index f58ece42..da3aca0d 100644
--- a/docs/reference.xml
+++ b/docs/reference.xml
@@ -5201,6 +5201,27 @@ name="AssaultCube Documentation" version="Current" xsi:schemaLocation="xml/cuber
           </references>
         </command>
 
+        <variable name="cleanedit">
+          <description>Turns on/off clean edit mode.</description>
+          <remarks>
+            <remark>While editing in clean edit mode, objects/guides not normally visible remain invisible.</remark>
+            <remark>i.e. The grid guidelines, selection borders, entity sparkles, clips, playerstart arrows are hidden</remark>
+          </remarks>
+          <arguments>
+            <argument token="V" description="sets cleanedit on/off" valueNotes="0 (off), 1 (on)"/>
+          </arguments>
+          <references>
+            <identifierReference identifier="togglecleanedit"/>
+          </references>
+        </variable> 
+
+        <command name="togglecleanedit">
+          <description>Inverses the on/off state of cleanedit</description>
+          <references>
+            <identifierReference identifier="cleanedit"/>
+          </references>
+        </command>       
+
         <command name="recalc">
           <description>Recomputes all there is to recompute about a map, currently only lighting.</description>
         </command>