Skip to content

Commit 908913a

Browse files
authored
fix some sexp help documentation (#20)
Fix the spelling of "targeted", "targeting", etc. Also remove the unintentionally misplaced text from `lua-get-prompt-response`. This is a superset of the old PR 8: AxemP/AxemFS2Scripts#8
1 parent e513d4c commit 908913a

7 files changed

Lines changed: 14 additions & 14 deletions

File tree

AxMiscFunctions/data/tables/misc-sc-functions-sct.tbm

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ end
144144

145145
mn.LuaSEXPs["lua-unlockdown"].Action = UnLockdownSEXP
146146

147-
function Targettable(name)
147+
function Targetable(name)
148148

149149
local isplayer = "false"
150150

@@ -160,7 +160,7 @@ mn.runSEXP("( friendly-stealth-visible !" .. name .. "! )")
160160

161161
end
162162

163-
function UnTargettable(name)
163+
function UnTargetable(name)
164164

165165
local isplayer = "false"
166166

@@ -181,7 +181,7 @@ mn.LuaSEXPs["lua-set-targetable"].Action = function(...)
181181
for _, data in ipairs(arg) do
182182
local ship = data[1]
183183
if ship:isValid() then
184-
Targettable(ship.Name)
184+
Targetable(ship.Name)
185185
end
186186
end
187187

@@ -192,7 +192,7 @@ mn.LuaSEXPs["lua-set-untargetable"].Action = function(...)
192192
for _, data in ipairs(arg) do
193193
local ship = data[1]
194194
if ship:isValid() then
195-
UnTargettable(ship.Name)
195+
UnTargetable(ship.Name)
196196
end
197197
end
198198

AxMiscFunctions/data/tables/misc-sc-functions-sexp.tbm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ $Category: Change
6767
$Subcategory: Scripted
6868
$Minimum Arguments: 1
6969
$Return Type: Nothing
70-
$Description: Clears any flag that may prevent a ship to be targetted. (Invisible, stealthy, friendly-stealthy)
70+
$Description: Clears any flag that may prevent a ship to be targeted. (Invisible, stealthy, friendly-stealthy)
7171
$Repeat
7272
$Parameter:
7373
+Description: Ships to become targetable
@@ -78,7 +78,7 @@ $Category: Change
7878
$Subcategory: Scripted
7979
$Minimum Arguments: 1
8080
$Return Type: Nothing
81-
$Description: Sets any flag that causes a ship to be targetted. (Invisible, stealthy, friendly-stealthy)
81+
$Description: Sets any flag that causes a ship to be targeted. (Invisible, stealthy, friendly-stealthy)
8282
$Repeat
8383
$Parameter:
8484
+Description: Ships to become untargetable

IMJumpMultiSEXPs/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
# In Mission Jump Multi SEXPs
3-
These sexps are for doing in-mission jumps for one or more ships simultaneously. For player ships, they will perform all the associated effects for a jump including the warp effect and the subspace tunnel. For non player ships, they will perform warp outs, move the ships far away and set them as untargettable, and then return them at the appropriate time with a warp effect.
3+
These sexps are for doing in-mission jumps for one or more ships simultaneously. For player ships, they will perform all the associated effects for a jump including the warp effect and the subspace tunnel. For non player ships, they will perform warp outs, move the ships far away and set them as untargetable, and then return them at the appropriate time with a warp effect.
44

55
You can jump multiple ships with a single sexp and they will be placed a set distance apart from each other at the target waypoint upon emerging from subspace.
66

MarkBox/data/tables/markbox-sexp.tbm

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ $Subcategory: Scripted
66
$Minimum Arguments: 2
77
; No maximum arguments means that it accepts a variable number of arguments
88
$Return Type: Nothing
9-
$Description: Highlights a ship to draw player attention to it. Text will be displayed by the ship when targetted.
9+
$Description: Highlights a ship to draw player attention to it. Text will be displayed by the ship when targeted.
1010
$Parameter:
1111
+Description: Text to display
1212
+Type: string
@@ -21,7 +21,7 @@ $Subcategory: Scripted
2121
$Minimum Arguments: 2
2222
; No maximum arguments means that it accepts a variable number of arguments
2323
$Return Type: Nothing
24-
$Description: Highlights all ships in a wing to draw player attention to them. Text will be displayed by a ship when targetted.
24+
$Description: Highlights all ships in a wing to draw player attention to them. Text will be displayed by a ship when targeted.
2525
$Parameter:
2626
+Description: Text to display
2727
+Type: string
@@ -36,7 +36,7 @@ $Subcategory: Scripted
3636
$Minimum Arguments: 3
3737
; No maximum arguments means that it accepts a variable number of arguments
3838
$Return Type: Nothing
39-
$Description: Highlights subsystems on a ship to assist the player in targetting specific subsystems. Text will be displayed by the subsystem when targetted.
39+
$Description: Highlights subsystems on a ship to assist the player in targeting specific subsystems. Text will be displayed by the subsystem when targeted.
4040
$Parameter:
4141
+Description: Ship that has the subsystem to highlight
4242
+Type: Ship
@@ -54,7 +54,7 @@ $Subcategory: Scripted
5454
$Minimum Arguments: 1
5555
$Maximum Arguments: 2
5656
$Return Type: Nothing
57-
$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.
57+
$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.
5858
$Parameter:
5959
+Description: Weapon to highlight
6060
+Type: string

MarkBox/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Mark Box
22

3-
This script will allow the mission designer to highlight certain ships, wings and subsystems. This script does not do targetting, only highlighting. For ships and wings, brackets will be drawn around the ships at all times. An optional text string will be drawn over a ship if it has been targetted. For subsystems, brackets will only be drawn if the parent ship is targetted. A simple health bar is also drawn next to the subsystem.
3+
This script will allow the mission designer to highlight certain ships, wings and subsystems. This script does not do targeting, only highlighting. For ships and wings, brackets will be drawn around the ships at all times. An optional text string will be drawn over a ship if it has been targeted. For subsystems, brackets will only be drawn if the parent ship is targeted. A simple health bar is also drawn next to the subsystem.
44

55
A sample mission is included

PromptBox/data/tables/proBox-sexp.tbm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ $Subcategory: Player
6767
$Minimum Arguments: 1
6868
$Maximum Arguments: 1
6969
$Return Type: number
70-
$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.
70+
$Description: This will return 0 when uninitialized or waiting for a response, or 1-5 based on the last response.
7171
$Parameter:
7272
+Description: Prompt Reference to use
7373
+Type: string

TurretHotkey/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Turret Hotkey
22

3-
A simple script that allows a hotkey targetting functionality work for subsystems. Works pretty well with the MarkBox script!
3+
A simple script that allows a hotkey targeting functionality work for subsystems. Works pretty well with the MarkBox script!

0 commit comments

Comments
 (0)