Skip to content

fix some sexp help documentation #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Goober5000 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix some sexp help documentation #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions MarkBox/data/tables/markbox-sexp.tbm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions MiscFunctions/data/tables/misc-sc-functions-sexp.tbm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion PromptBox/data/tables/proBox-sexp.tbm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down