From 017c485ef90b7181f848826270c21a084c93bfd8 Mon Sep 17 00:00:00 2001 From: Goober5000 Date: Mon, 4 Oct 2021 22:47:02 -0400 Subject: [PATCH] fix some sexp help documentation Some spelling fixes. Also remove the unintentionally misplaced text from `lua-get-prompt-response`. --- MarkBox/data/tables/markbox-sexp.tbm | 8 ++++---- MiscFunctions/data/tables/misc-sc-functions-sexp.tbm | 4 ++-- PromptBox/data/tables/proBox-sexp.tbm | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/MarkBox/data/tables/markbox-sexp.tbm b/MarkBox/data/tables/markbox-sexp.tbm index 99f59b5..e7db5b2 100644 --- a/MarkBox/data/tables/markbox-sexp.tbm +++ b/MarkBox/data/tables/markbox-sexp.tbm @@ -6,7 +6,7 @@ $Subcategory: Scripted $Minimum Arguments: 2 ; No maximum arguments means that it accepts a variable number of arguments $Return Type: Nothing -$Description: Highlights a ship to draw player attention to it. Text will be displayed by the ship when targetted. +$Description: Highlights a ship to draw player attention to it. Text will be displayed by the ship when targeted. $Parameter: +Description: Text to display +Type: string @@ -21,7 +21,7 @@ $Subcategory: Scripted $Minimum Arguments: 2 ; No maximum arguments means that it accepts a variable number of arguments $Return Type: Nothing -$Description: Highlights all ships in a wing to draw player attention to them. Text will be displayed by a ship when targetted. +$Description: Highlights all ships in a wing to draw player attention to them. Text will be displayed by a ship when targeted. $Parameter: +Description: Text to display +Type: string @@ -36,7 +36,7 @@ $Subcategory: Scripted $Minimum Arguments: 3 ; No maximum arguments means that it accepts a variable number of arguments $Return Type: Nothing -$Description: Highlights subsystems on a ship to assist the player in targetting specific subsystems. Text will be displayed by the subsystem when targetted. +$Description: Highlights subsystems on a ship to assist the player in targeting specific subsystems. Text will be displayed by the subsystem when targeted. $Parameter: +Description: Ship that has the subsystem to highlight +Type: Ship @@ -54,7 +54,7 @@ $Subcategory: Scripted $Minimum Arguments: 1 $Maximum Arguments: 2 $Return Type: Nothing -$Description: Highlights weapons to help player identify important targets. Text will be displayed by the weapon when targetted. You can also specify a ship to tie distance calculations with the "lua-get-weapon-distance" sexp. The ship is pre-defined here for consideration of how much computing time calculating distances for tons of weapons can have on your poor CPU. +$Description: Highlights weapons to help player identify important targets. Text will be displayed by the weapon when targeted. You can also specify a ship to tie distance calculations with the "lua-get-weapon-distance" sexp. The ship is pre-defined here for consideration of how much computing time calculating distances for tons of weapons can have on your poor CPU. $Parameter: +Description: Weapon to highlight +Type: string diff --git a/MiscFunctions/data/tables/misc-sc-functions-sexp.tbm b/MiscFunctions/data/tables/misc-sc-functions-sexp.tbm index e000eac..2d9e6dd 100644 --- a/MiscFunctions/data/tables/misc-sc-functions-sexp.tbm +++ b/MiscFunctions/data/tables/misc-sc-functions-sexp.tbm @@ -67,7 +67,7 @@ $Category: Change $Subcategory: Scripted $Minimum Arguments: 1 $Return Type: Nothing -$Description: Clears any flag that may prevent a ship to be targetted. (Invisible, stealthy, friendly-stealthy) +$Description: Clears any flag that may prevent a ship to be targeted. (Invisible, stealthy, friendly-stealthy) $Repeat $Parameter: +Description: Ships to become targetable @@ -78,7 +78,7 @@ $Category: Change $Subcategory: Scripted $Minimum Arguments: 1 $Return Type: Nothing -$Description: Sets any flag that causes a ship to be targetted. (Invisible, stealthy, friendly-stealthy) +$Description: Sets any flag that causes a ship to be targeted. (Invisible, stealthy, friendly-stealthy) $Repeat $Parameter: +Description: Ships to become untargetable diff --git a/PromptBox/data/tables/proBox-sexp.tbm b/PromptBox/data/tables/proBox-sexp.tbm index b5ccdaf..a9eaa57 100644 --- a/PromptBox/data/tables/proBox-sexp.tbm +++ b/PromptBox/data/tables/proBox-sexp.tbm @@ -67,7 +67,7 @@ $Subcategory: Player $Minimum Arguments: 1 $Maximum Arguments: 1 $Return Type: number -$Description: Highlights all ships in a wing to draw player attention to them. Text will be displayed by a ship when targetted. This will return 0 when uninitialized or waiting for a response, or 1-5 based on the last response. +$Description: This will return 0 when uninitialized or waiting for a response, or 1-5 based on the last response. $Parameter: +Description: Prompt Reference to use +Type: string