adds unsupported procs/vars (#135)

hry-gh · web-flow · commit 9e903999a7bd · 2025-07-02T09:55:01.000+01:00
fixes #134 --------- Co-authored-by: harryob <55142896+harryob@users.noreply.github.com>
diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
@@ -33,7 +33,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "Add 'CI Approval Required' Label"
-        if: (github.event.action == 'synchronize' || github.event.action == 'reopened') || ((github.event.action == 'opened' || github.event.action == 'labeled') && !contains(github.event.pull_request.labels.*.name, 'CI Cleared'))
+        if: (github.event.action == 'opened' || github.event.action == 'labeled' || github.event.action == 'synchronize' || github.event.action == 'reopened') && !contains(github.event.pull_request.labels.*.name, 'CI Cleared')
         uses: actions-ecosystem/action-add-labels@18f1af5e3544586314bbe15c0273249c770b2daf
         with:
           labels: CI Approval Required
@@ -84,4 +84,4 @@ jobs:
           umbrella-dir: ./pr-preview/
           deploy-repository: ${{ env.DEPLOY_REPO_OWNER }}/${{ env.DEPLOY_REPO }}
           custom-url: "ref.opendre.am"
-          action: deploy
+          action: deploy
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ We can use shortcodes to render specific HTML within our Markdown files. They're
 ```
 
 Currently, we have 4 callout shortcodes, which all take a `description` argument:
-- never_implemented
+- unsupported
 - od_only
 - parity
 - unimplemented
diff --git a/content/language/proc/link.md b/content/language/proc/link.md
@@ -9,7 +9,7 @@ description = "Where the user should be connected to."
 
 This is combined with the [<< output](@/language/operators/lessless/output.md) operator to send a link to a client. This will open in the user's browser.
 
-{% never_implemented() %}
+{% unsupported() %}
 In BYOND, a BYOND server address can be provided. This will disconnect and reconnect the user to the provided world, eg:
 
 ```dm
diff --git a/content/objects/client/proc/checkpassport.md b/content/objects/client/proc/checkpassport.md
@@ -1,6 +1,8 @@
 +++
 title = "CheckPassport"
 slug = "CheckPassport" # AUTOGEN FIELD
+[extra]
+od_unsupported = true # AUTOGEN FIELD
 [[extra.args]]
 name = "passport_identifier" # AUTOGEN STATIC
 +++
diff --git a/content/objects/client/proc/isbyondmember.md b/content/objects/client/proc/isbyondmember.md
@@ -2,4 +2,5 @@
 title = "IsByondMember"
 slug = "IsByondMember" # AUTOGEN FIELD
 [extra]
+od_unsupported = true # AUTOGEN FIELD
 +++
diff --git a/content/objects/client/proc/sendpage.md b/content/objects/client/proc/sendpage.md
@@ -1,6 +1,8 @@
 +++
 title = "SendPage"
 slug = "SendPage" # AUTOGEN FIELD
+[extra]
+od_unsupported = true # AUTOGEN FIELD
 [[extra.args]]
 name = "msg" # AUTOGEN STATIC
 [[extra.args]]
diff --git a/content/objects/client/var/byond_build.md b/content/objects/client/var/byond_build.md
@@ -1,6 +1,6 @@
 +++
 title = "byond_build"
 [extra]
-default_value = "1633" # AUTOGEN FIELD
+default_value = "1655" # AUTOGEN FIELD
 is_override = false # AUTOGEN FIELD
 +++
diff --git a/content/objects/client/var/byond_version.md b/content/objects/client/var/byond_version.md
@@ -1,6 +1,6 @@
 +++
 title = "byond_version"
 [extra]
-default_value = "515" # AUTOGEN FIELD
+default_value = "516" # AUTOGEN FIELD
 is_override = false # AUTOGEN FIELD
 +++
diff --git a/content/objects/client/var/gender.md b/content/objects/client/var/gender.md
@@ -3,5 +3,6 @@ title = "gender"
 [extra]
 default_value = "neuter" # AUTOGEN FIELD
 is_override = false # AUTOGEN FIELD
-type = "text" # AUTOGEN FIELD
+type = "text, unsupported" # AUTOGEN FIELD
+od_unsupported = true # AUTOGEN FIELD
 +++
diff --git a/content/objects/world/proc/addcredits.md b/content/objects/world/proc/addcredits.md
@@ -1,6 +1,8 @@
 +++
 title = "AddCredits"
 slug = "AddCredits" # AUTOGEN FIELD
+[extra]
+od_unsupported = true # AUTOGEN FIELD
 [[extra.args]]
 name = "player" # AUTOGEN STATIC
 [[extra.args]]
diff --git a/content/objects/world/proc/clearmedal.md b/content/objects/world/proc/clearmedal.md
@@ -2,4 +2,5 @@
 title = "ClearMedal"
 slug = "ClearMedal" # AUTOGEN FIELD
 [extra]
+od_unsupported = true # AUTOGEN FIELD
 +++
diff --git a/content/objects/world/proc/getcredits.md b/content/objects/world/proc/getcredits.md
@@ -1,6 +1,8 @@
 +++
 title = "GetCredits"
 slug = "GetCredits" # AUTOGEN FIELD
+[extra]
+od_unsupported = true # AUTOGEN FIELD
 [[extra.args]]
 name = "player" # AUTOGEN STATIC
 +++
diff --git a/content/objects/world/proc/getmedal.md b/content/objects/world/proc/getmedal.md
@@ -2,4 +2,5 @@
 title = "GetMedal"
 slug = "GetMedal" # AUTOGEN FIELD
 [extra]
+od_unsupported = true # AUTOGEN FIELD
 +++
diff --git a/content/objects/world/proc/getscores.md b/content/objects/world/proc/getscores.md
@@ -2,4 +2,5 @@
 title = "GetScores"
 slug = "GetScores" # AUTOGEN FIELD
 [extra]
+od_unsupported = true # AUTOGEN FIELD
 +++
diff --git a/content/objects/world/proc/issubscribed.md b/content/objects/world/proc/issubscribed.md
@@ -1,6 +1,8 @@
 +++
 title = "IsSubscribed"
 slug = "IsSubscribed" # AUTOGEN FIELD
+[extra]
+od_unsupported = true # AUTOGEN FIELD
 [[extra.args]]
 name = "player" # AUTOGEN STATIC
 [[extra.args]]
diff --git a/content/objects/world/proc/paycredits.md b/content/objects/world/proc/paycredits.md
@@ -1,6 +1,8 @@
 +++
 title = "PayCredits"
 slug = "PayCredits" # AUTOGEN FIELD
+[extra]
+od_unsupported = true # AUTOGEN FIELD
 [[extra.args]]
 name = "player" # AUTOGEN STATIC
 [[extra.args]]
diff --git a/content/objects/world/proc/setmedal.md b/content/objects/world/proc/setmedal.md
@@ -2,4 +2,5 @@
 title = "SetMedal"
 slug = "SetMedal" # AUTOGEN FIELD
 [extra]
+od_unsupported = true # AUTOGEN FIELD
 +++
diff --git a/content/objects/world/proc/setscores.md b/content/objects/world/proc/setscores.md
@@ -2,4 +2,5 @@
 title = "SetScores"
 slug = "SetScores" # AUTOGEN FIELD
 [extra]
+od_unsupported = true # AUTOGEN FIELD
 +++
diff --git a/content/objects/world/var/byond_build.md b/content/objects/world/var/byond_build.md
@@ -1,6 +1,6 @@
 +++
 title = "byond_build"
 [extra]
-default_value = "1633" # AUTOGEN FIELD
+default_value = "1655" # AUTOGEN FIELD
 is_override = false # AUTOGEN FIELD
 +++
diff --git a/content/objects/world/var/byond_version.md b/content/objects/world/var/byond_version.md
@@ -1,6 +1,6 @@
 +++
 title = "byond_version"
 [extra]
-default_value = "515" # AUTOGEN FIELD
+default_value = "516" # AUTOGEN FIELD
 is_override = false # AUTOGEN FIELD
 +++
diff --git a/content/reference/contributing.md b/content/reference/contributing.md
@@ -18,14 +18,14 @@ We can use shortcodes to render specific HTML within our Markdown files. They're
 ```
 
 Currently, we have 4 callout shortcodes, which all take a `description` argument. However, the preferred way of invoking them is:
-### never_implemented
+### unsupported
 
 ```go
-{%/* never_implemented() */%}
+{%/* unsupported() */%}
 Like this!
 {%/* end */%}
 ```
-{% never_implemented() %}
+{% unsupported() %}
 Like this!
 {% end %}
 
diff --git a/templates/macros.html b/templates/macros.html
@@ -181,7 +181,7 @@
             <div class="{% if not list %}text-xl{% endif %}">Arguments:</div>
             <div class="flex flex-col">
             {% for arg in page.extra.args %}
-                <div class="pl-5">{{arg.name}}{% if arg.type %} ({{ self::render_single_type(type=arg.type)}}){% endif %}{%- if arg.default_value %} = {{arg.default_value}}{% endif %}{% if arg.description %}: {{arg.description}}{% endif %}{%- if arg.od_unimplemented -%}<div class="text-sm text-red-400 border-l-2 border-red-400 pl-2 inline ml-2">Unimplemented 🏗️</div>{%- endif -%}</div>
+                <div class="pl-5">{{arg.name}}{% if arg.type %} ({{ self::render_single_type(type=arg.type)}}){% endif %}{%- if arg.default_value %} = {{arg.default_value}}{% endif %}{% if arg.description %}: {{arg.description}}{% endif %}{%- if arg.od_unimplemented -%}<div class="text-sm text-red-400 border-l-2 border-red-400 pl-2 inline ml-2">Unimplemented 🏗️</div>{%- endif -%}{%- if arg.od_unsupported -%}<div class="text-sm text-[#b91c1c] border-l-2 border-[#b91c1c] pl-2 inline ml-2">Unsupported ⛔</div>{%- endif -%}</div>
             {% endfor %}
             </div>
         </div>
@@ -195,7 +195,7 @@
         {% for form in page.extra.format %}
             <div class="pl-5">{{ page.title }}(
             {%- for arg in form -%}
-            {% if arg.type %}{{ self::render_single_type(type=arg.type)}}/{% endif %}{{arg.name}}{%- if arg.default_value %} = {{ arg.default_value }}{% endif %}{% if not loop.last %},{% endif %}{%- if arg.od_unimplemented -%}<div class="text-sm text-red-400 border-l-2 border-red-400 pl-2 inline ml-2">Unimplemented 🏗️</div>{%- endif -%}{% if not loop.last %} {% endif -%}
+            {% if arg.type %}{{ self::render_single_type(type=arg.type)}}/{% endif %}{{arg.name}}{%- if arg.default_value %} = {{ arg.default_value }}{% endif %}{% if not loop.last %},{% endif %}{%- if arg.od_unimplemented -%}<div class="text-sm text-red-400 border-l-2 border-red-400 pl-2 inline ml-2">Unimplemented 🏗️</div>{%- endif -%}{%- if arg.od_unsupported -%}<div class="text-sm text-[#b91c1c] border-l-2 border-[#b91c1c] pl-2 inline ml-2">Unsupported ⛔</div>{%- endif -%}{% if not loop.last %} {% endif -%}
             {% endfor -%}
             ){% for arg in form %}
             {%- if arg.description -%}
@@ -362,6 +362,16 @@ <h4 class="pt-3">See also:</h4>
         smalltext=list)
     }}
     {% endif %}
+    {%- if arg.od_unsupported -%}<div class="text-sm text-[#b91c1c] border-l-2 border-[#b91c1c] pl-2 inline ml-2">Unsupported ⛔</div>{%- endif -%}
+
+    {% if page.extra.od_unsupported %}
+    {{ sc::render_callout(color="#b91c1c", 
+        title="Unsupported ⛔", 
+        body="In the OpenDream implementation of DreamMaker, this proc will not be supported.", 
+        smalltext=list) 
+    }}
+    {% endif %}
+
 
     <div class="page-content">
     {{ page.content | safe }}
@@ -462,6 +472,14 @@ <h4 class="pt-3">See also:</h4>
     }}
     {% endif %}
 
+    {% if page.extra.od_unsupported %}
+    {{ sc::render_callout(color="#b91c1c", 
+        title="Unsupported ⛔", 
+        body="In the OpenDream implementation of DreamMaker, this variable will not be supported.", 
+        smalltext=list) 
+    }}
+    {% endif %}
+
     <div class="page-content">
     {{ page.content | safe }}
     </div>
diff --git a/templates/shortcodes/unsupported.html b/templates/shortcodes/unsupported.html
@@ -7,7 +7,7 @@
     {%- set contents = description -%}
 {%- endif -%}
 {{ sc::render_callout(color="#b91c1c", 
-    title="Never Implemented ⛔", 
-    body="In the OpenDream implementation of DreamMaker, this feature will not be implemented:", 
+    title="Unsupported ⛔", 
+    body="In the OpenDream implementation of DreamMaker, this feature will not be supported:", 
     contents=contents) 
 }}
diff --git a/tools/OpenDreamDocumentationTool/OpenDream b/tools/OpenDreamDocumentationTool/OpenDream
@@ -1 +1 @@
-Subproject commit bb9f8d36dcc9e5dcd4a46c68c27a588ff2e280c1
+Subproject commit 371e56348e6c8c3d7953255bdc21a7c91853b509
diff --git a/tools/OpenDreamDocumentationTool/OpenDreamDocumentationTool/Program.cs b/tools/OpenDreamDocumentationTool/OpenDreamDocumentationTool/Program.cs
