Update is_success, is_critical description, related BGforgeNet/Fallou…

…t2_Unofficial_Patch#112
BGforgeNet · Apr 16, 2024 · 66a4368 · 66a4368
1 parent e14b99e
commit 66a4368
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/server/data/fallout-ssl-base.yml b/server/data/fallout-ssl-base.yml
@@ -520,9 +520,9 @@ base-functions:
       doc: |-
         Attempts to cause a critter to unwield any wielded weapons/items. If animations are currently disabled, it will just instantly change the art.
     - name: is_critical
-      detail: bool is_critical(int val)
+      detail: bool is_critical(int rollResult)
       doc: |-
-        Returns True if a given contest roll result is a critical result, otherwise False.
+        Returns `True` if a given contest roll result is a critical result, otherwise `False`.
     - name: is_loading_game
       detail: bool is_loading_game
       doc: |-
@@ -532,9 +532,9 @@ base-functions:
       doc: |-
         Returns True if a given skill is tagged.
     - name: is_success
-      detail: int is_success(int val)
+      detail: int is_success(int rollResult)
       doc: |-
-        Returns True if a given contest roll result value is a success, otherwise False. Can generate Critical Success or Critical Failure as well.
+        Return `True` if a given contest roll result value is a success (including critical success), otherwise `False`.
     - name: item_caps_adjust
       detail: int item_caps_adjust(ObjectPtr obj, int amount)
       doc: |-

diff --git a/server/out/completion.fallout-ssl.json b/server/out/completion.fallout-ssl.json
@@ -1098,7 +1098,7 @@
         "source": "builtin",
         "documentation": {
             "kind": "markdown",
-            "value": "```fallout-ssl-tooltip\nbool is_critical(int val)\n```\nReturns True if a given contest roll result is a critical result, otherwise False."
+            "value": "```fallout-ssl-tooltip\nbool is_critical(int rollResult)\n```\nReturns `True` if a given contest roll result is a critical result, otherwise `False`."
         }
     },
     {
@@ -1125,7 +1125,7 @@
         "source": "builtin",
         "documentation": {
             "kind": "markdown",
-            "value": "```fallout-ssl-tooltip\nint is_success(int val)\n```\nReturns True if a given contest roll result value is a success, otherwise False. Can generate Critical Success or Critical Failure as well."
+            "value": "```fallout-ssl-tooltip\nint is_success(int rollResult)\n```\nReturn `True` if a given contest roll result value is a success (including critical success), otherwise `False`."
         }
     },
     {

diff --git a/server/out/hover.fallout-ssl.json b/server/out/hover.fallout-ssl.json
@@ -680,7 +680,7 @@
     "is_critical": {
         "contents": {
             "kind": "markdown",
-            "value": "```fallout-ssl-tooltip\nbool is_critical(int val)\n```\nReturns True if a given contest roll result is a critical result, otherwise False."
+            "value": "```fallout-ssl-tooltip\nbool is_critical(int rollResult)\n```\nReturns `True` if a given contest roll result is a critical result, otherwise `False`."
         }
     },
     "is_loading_game": {
@@ -698,7 +698,7 @@
     "is_success": {
         "contents": {
             "kind": "markdown",
-            "value": "```fallout-ssl-tooltip\nint is_success(int val)\n```\nReturns True if a given contest roll result value is a success, otherwise False. Can generate Critical Success or Critical Failure as well."
+            "value": "```fallout-ssl-tooltip\nint is_success(int rollResult)\n```\nReturn `True` if a given contest roll result value is a success (including critical success), otherwise `False`."
         }
     },
     "item_caps_adjust": {