Dynamic SEXPs - Revision history

Shivan Hunter: Fix nonfunctioning example code

2025-08-16T16:16:18Z

Fix nonfunctioning example code

← Older revision		Revision as of 16:16, 16 August 2025
Line 323:		Line 323:
	$On Game Init: [		$On Game Init: [
	mn.LuaSEXPs["dynamic-sexp"].Action = function (arg1, arg2, arg3, ...)		mn.LuaSEXPs["dynamic-sexp"].Action = function (arg1, arg2, arg3, ...)
	ba.print(tostring(arg1)		ba.print(tostring(arg1))
	ba.print(arg2.Name)		ba.print(arg2.Name)
	ba.print(tostring(arg3.Value))		ba.print(tostring(arg3.Value))

	for val in ~~{...}~~ do		for _, val in ipairs(arg) do
	ba.print(val[1])		ba.print(val[1])
	ba.print(tostring(val[2]))		ba.print(tostring(val[2]))
	~~done~~		end
	end		end
	]		]

Goober5000: /* +Parent Parameter Index: */ correct and clarify

2024-11-25T06:35:15Z

+Parent Parameter Index:: correct and clarify

← Older revision		Revision as of 06:35, 25 November 2024
Line 139:		Line 139:
	====+Parent Parameter Index:====		====+Parent Parameter Index:====
	{{Table232\|		{{Table232\|
	*The ~~zero-based~~ index to the parent parameter that should be used for types that require it.		*The index of the parent parameter that should be used for types that require it. For example, '''subsystem''' parameters need to refer to a parent '''ship''' parameter so that the SEXP system knows which subsystems are relevant to that ship. This index counts the parameters starting at 1.
	*If [[Dynamic_SEXPs#$Repeat\|$Repeat]] is used then the last parsed index is the one that will be repeated.		*If [[Dynamic_SEXPs#$Repeat\|$Repeat]] is used then the last parsed index is the one that will be repeated.
	*An index setting of -1 will always return the immediately previous ~~sexp~~ argument, even if [[Dynamic_SEXPs#$Repeat\|$Repeat]] is active.		*An index setting of -1 will always return the immediately previous SEXP argument, even if [[Dynamic_SEXPs#$Repeat\|$Repeat]] is active.
	*Defaults to -1 if this is not provided for a type that requires it		*Defaults to -1 if this is not provided for a type that requires it
	*Syntax: '''''Integer'''''}}		*Syntax: '''''Integer'''''}}

Naomimyselfandi at 21:15, 6 May 2024

2024-05-06T21:15:18Z

← Older revision		Revision as of 21:15, 6 May 2024
Line 203:		Line 203:

	=====+Target Restrictions:=====		=====+Target Restrictions:=====
	*~~If the AI goal requires a target, defines which requirements~~ a ship must fulfill to be a valid target for this order		*Requirements a ship must fulfill to be a valid target for this order. This may be fine-tuned by registering a `TargetRestrict` function.
	**; All: Any ship is a valid target		**; All: Any ship is a valid target.
	**; Allies: The target must be of a team that is not attacked by the player		**; Allies: The target must be of a team that is not attacked by the player.
	**; Own Team: The target must be of the same team as the player		**; Own Team: The target must be of the same team as the player.
	**; Hostiles: The target must be of a team that is attacked by the player		**; Hostiles: The target must be of a team that is attacked by the player.
	**; Same Wing: The target and the ship receiving the order must be on the same wing		**; Same Wing: The target and the ship receiving the order must be on the same wing.
	**; Player Wing: The target and the player must be on the same wing		**; Player Wing: The target and the player must be on the same wing.
	**; Capitals: The ship must be a capital ship		**; Capitals: The ship must be a capital ship (i.e. any large ship, including a transport or freighter).
	**; Allied Capitals: The ship must be an ally and a capital ship		**; Allied Capitals: The ship must be an ally and a capital ship.
	**; Enemy Capitals: The ship must be a hostile and a capital ship		**; Enemy Capitals: The ship must be a hostile and a capital ship.
	*Optional. All by default		**; Not Self: The ship must not be the ship receiving the order.
			*Optional. All by default.
	*Syntax: '''''String'''''		*Syntax: '''''String'''''

			{{Table232\|
			=====+Ship Restrictions:=====
			*Requirements on what can receive this order.
			**; Any: Any ship or wing can receive this order.
			**; On Player Wing: Only a ship on the player's wing can receive this order.
			**; Wing: This order may only be sent to wings, not individual ships.
			**; Player Wing: This order may only be sent to the player's wing.
			*Optional. All by default.
			*Syntax: '''''String'''''
			}}

	=====+Acknowledge Message:=====		=====+Acknowledge Message:=====
Line 324:		Line 336:
	#End		#End
	</pre>		</pre>

	===Lua AI===		===Lua AI===
	~~The setup for~~ Lua ~~AI is very similar to the setup to Lua SEXP, except that~~ two functions ~~must be supplied~~, ~~one for~~ when the ~~AI starts executing, and one that~~ is called ~~each~~ frame.
	~~These~~ functions ~~will be passed~~ an ~~AI control helper~~ object ~~that can be used to easily control the ships behaviour from Lua~~, ~~as well as an oswpt-type object containing~~ the target ~~data~~, if ~~applicable~~.		LuaAI operators are more complicated than standard Lua operators. They are defined by two main functions and two optional functions.
	~~In addition~~, the ~~functions are expected to~~ return ~~a boolean value~~, ~~representing~~ the ~~state of~~ the ~~action~~. ~~Returning true implies that the action is complete~~, ~~and that~~ the ~~AI goal should~~ be ~~removed automatically (similarly~~ to ~~how~~ a ~~chase order~~ is ~~removed when~~ the target ~~is killed)~~.
			The <code>ActionEnter</code> and <code>ActionFrame</code> functions define the operator's behavior. <code>ActionEnter</code> is called only once, when a ship receives the order; it may be used for any needed setup. <code>ActionFrame</code> is called once per frame. Both functions receive an <code>ai_helper</code> object, the target (if any), and any additional arguments; they should return <code>true</code> if the order is complete, and <code>false</code> otherwise.

			The <code>Achievability</code> function defines whether the order is currently achievable. It accepts the ship executing the order, the target (if any), and any additional arguments. It may return <code>LUAAI_ACHIEVABLE</code> if the order can currently be achieved, <code>LUAAI_UNACHIEVABLE</code> if the order cannot be achieved and should be removed from the ship, and <code>LUAAI_NOT_YET_ACHIEVABLE</code> if the order cannot currently be achieved, but may become possible later; this allows an order which doesn't make sense right now to be suspended until later.

			Lastly, the <code>TargetRestrict</code> function may be used to fine-tune the order's targeting. It accepts a ship and a nilable OSWPT handle representing the target, and returns whether or not the target is valid. This is checked only if the target already satisfies the `+Target Restrictions:`.

	Example:		Example:
Line 336:		Line 354:
	$Application: FS2_Open		$Application: FS2_Open
	$On Game Init: [		$On Game Init: [
	mn.LuaAISEXPs["~~dynamic~~-ai"].ActionEnter = function(ai_helper, target)		mn.LuaAISEXPs["ai-ram"].ActionEnter = function(ai_helper, target)
	--Print info to the log		--Print info to the log
	ba.print("Targeting " .. target:get().Name .. " from " .. ai_helper.Ship.Name .. "!")		ba.print("Targeting " .. target:get().Name .. " from " .. ai_helper.Ship.Name .. "!")
Line 342:		Line 360:
	end		end

	mn.LuaAISEXPs["~~dynamic~~-ai"].ActionFrame = function(ai_helper, target)		mn.LuaAISEXPs["ai-ram"].ActionFrame = function(ai_helper, target)
	--Turn towards and fly into the target		--Turn towards and fly into the target
	helper:turnTowardsPoint(target:get().Position)		helper:turnTowardsPoint(target:get().Position)
	helper.ForwardThrust = 1		helper.ForwardThrust = 1
	return false		return false
			end

			mn.LuaAISEXPs["ai-ram"].Achievability = function(ship, target)
			if ship.Disabled then
			-- Contrived example
			return LUAAI_NOT_YET_ACHIEVABLE
			elseif target:isValid() then
			return LUAAI_ACHIEVABLE
			else
			return LUAAI_UNACHIEVABLE
			end
	end		end
	]		]

MjnMixael at 22:05, 13 December 2023

2023-12-13T22:05:32Z

← Older revision		Revision as of 22:05, 13 December 2023
Line 144:		Line 144:
	*Defaults to -1 if this is not provided for a type that requires it		*Defaults to -1 if this is not provided for a type that requires it
	*Syntax: '''''Integer'''''}}		*Syntax: '''''Integer'''''}}

			====+Suffix:====
			{{Table240\|
			*An arbitrary string to suffix to the enum parent's name.
			*For example, if the parent enum is a ship type, you can add the suffix and the enum list that will be used will be SHIPNAME + suffix
			*Syntax: '''''string'''''}}

	{{Table222\|		{{Table222\|

MjnMixael: /* +Type: */

2023-12-13T22:03:32Z

+Type:

← Older revision		Revision as of 22:03, 13 December 2023
Line 117:		Line 117:
	{{Table234\|		{{Table234\|
	**; waypoint: This is a reference to a waypoint. The script will receive it as an <tt>oswpt</tt> handle.		**; waypoint: This is a reference to a waypoint. The script will receive it as an <tt>oswpt</tt> handle.
	**; child_enum: A pre-defined enumeration list, but gets the list name from [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. Can optionally use [[Dynamic_SEXPs#+Suffix:\|+Suffix]]The script will receive it as a string.		**; child_enum: A pre-defined enumeration list, but gets the list name from [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. Can optionally use [[Dynamic_SEXPs#+Suffix:\|+Suffix]]. The script will receive it as a string.
	}}		}}
	*Syntax: '''''String'''''		*Syntax: '''''String'''''

MjnMixael: /* +Type: */

2023-12-13T22:03:20Z

+Type:

← Older revision		Revision as of 22:03, 13 December 2023
Line 117:		Line 117:
	{{Table234\|		{{Table234\|
	**; waypoint: This is a reference to a waypoint. The script will receive it as an <tt>oswpt</tt> handle.		**; waypoint: This is a reference to a waypoint. The script will receive it as an <tt>oswpt</tt> handle.
	**; child_enum: A pre-defined enumeration list, but gets the list name from [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. The script will receive it as a string.		**; child_enum: A pre-defined enumeration list, but gets the list name from [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. Can optionally use [[Dynamic_SEXPs#+Suffix:\|+Suffix]]The script will receive it as a string.
	}}		}}
	*Syntax: '''''String'''''		*Syntax: '''''String'''''

Mobius: Spelling

2023-11-14T08:45:43Z

Spelling

MjnMixael: /* +Type: */

2023-11-13T17:21:31Z

+Type:

← Older revision		Revision as of 17:21, 13 November 2023
Line 117:		Line 117:
	{{Table234\|		{{Table234\|
	**; waypoint: This is a reference to a waypoint. The script will recieve it as an <tt>oswpt</tt> handle.		**; waypoint: This is a reference to a waypoint. The script will recieve it as an <tt>oswpt</tt> handle.
			**; child_enum: A pre-defined enumeration list, but gets the list name from [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. The script will receive it as a string.
	}}		}}
	*Syntax: '''''String'''''		*Syntax: '''''String'''''

MjnMixael: /* +Type: */

2023-10-19T01:00:24Z

+Type:

← Older revision		Revision as of 01:00, 19 October 2023
Line 114:		Line 114:
	**; subsystem: This is a reference to a ship's subsystems and requires [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. The script will receive it as a <tt>subsystem</tt> handle.		**; subsystem: This is a reference to a ship's subsystems and requires [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. The script will receive it as a <tt>subsystem</tt> handle.
	**; dockpoint: This is a reference to a ship's docking points and requires [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. The script will receive it as a <tt>dockingbay</tt> handle.		**; dockpoint: This is a reference to a ship's docking points and requires [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. The script will receive it as a <tt>dockingbay</tt> handle.
			}}
			{{Table234\|
			**; waypoint: This is a reference to a waypoint. The script will recieve it as an <tt>oswpt</tt> handle.
	}}		}}
	*Syntax: '''''String'''''		*Syntax: '''''String'''''

MjnMixael: /* +Parent Parameter Index: */ default data note

2023-03-06T14:41:44Z

+Parent Parameter Index:: default data note

← Older revision		Revision as of 14:41, 6 March 2023
Line 138:		Line 138:
	*If [[Dynamic_SEXPs#$Repeat\|$Repeat]] is used then the last parsed index is the one that will be repeated.		*If [[Dynamic_SEXPs#$Repeat\|$Repeat]] is used then the last parsed index is the one that will be repeated.
	*An index setting of -1 will always return the immediately previous sexp argument, even if [[Dynamic_SEXPs#$Repeat\|$Repeat]] is active.		*An index setting of -1 will always return the immediately previous sexp argument, even if [[Dynamic_SEXPs#$Repeat\|$Repeat]] is active.
			*Defaults to -1 if this is not provided for a type that requires it
	*Syntax: '''''Integer'''''}}		*Syntax: '''''Integer'''''}}

← Older revision		Revision as of 08:45, 14 November 2023
Line 99:		Line 99:
	**; soundentry: This is a reference to a table defined game sound. The script will receive it as a <tt>soundentry</tt> handle.		**; soundentry: This is a reference to a table defined game sound. The script will receive it as a <tt>soundentry</tt> handle.
	{{Table220\|		{{Table220\|
	**; ship+waypoint: This can be a reference to either a ship, both present and not yet present, or a waypoint. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+waypoint: This can be a reference to either a ship, both present and not yet present, or a waypoint. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing: This can be a reference to either a ship or a wing, both present and not yet present. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing: This can be a reference to either a ship or a wing, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing+team: This can be a reference to either a ship, a wing or a whole team, both present and not yet present. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing+team: This can be a reference to either a ship, a wing or a whole team, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing+ship_on_team+waypoint: This can be a reference to either a ship, a wing, any ship on a team, or a waypoint, both present and not yet present. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing+ship_on_team+waypoint: This can be a reference to either a ship, a wing, any ship on a team, or a waypoint, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing+waypoint: This can be a reference to either a ship, a wing, or a waypoint, both present and not yet present. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing+waypoint: This can be a reference to either a ship, a wing, or a waypoint, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing+waypoint+none: This can be a reference to either a ship, a wing, a waypoint, both present and not yet present, or none. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing+waypoint+none: This can be a reference to either a ship, a wing, a waypoint, both present and not yet present, or none. The script will receive it as an <tt>oswpt</tt> handle.
	}}		}}
	{{Table224\|		{{Table224\|
Line 116:		Line 116:
	}}		}}
	{{Table234\|		{{Table234\|
	**; waypoint: This is a reference to a waypoint. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; waypoint: This is a reference to a waypoint. The script will receive it as an <tt>oswpt</tt> handle.
	**; child_enum: A pre-defined enumeration list, but gets the list name from [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. The script will receive it as a string.		**; child_enum: A pre-defined enumeration list, but gets the list name from [[Dynamic_SEXPs#+Parent Parameter Index:\|+Parent Parameter Index]]. The script will receive it as a string.
	}}		}}
Line 252:		Line 252:
	**; weaponclass: This is a reference to a table weapon class. The script will receive it as a <tt>weaponclass</tt> handle.		**; weaponclass: This is a reference to a table weapon class. The script will receive it as a <tt>weaponclass</tt> handle.
	**; soundentry: This is a reference to a table defined game sound. The script will receive it as a <tt>soundentry</tt> handle.		**; soundentry: This is a reference to a table defined game sound. The script will receive it as a <tt>soundentry</tt> handle.
	**; ship+waypoint: This can be a reference to either a ship, both present and not yet present, or a waypoint. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+waypoint: This can be a reference to either a ship, both present and not yet present, or a waypoint. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing: This can be a reference to either a ship or a wing, both present and not yet present. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing: This can be a reference to either a ship or a wing, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing+team: This can be a reference to either a ship, a wing or a whole team, both present and not yet present. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing+team: This can be a reference to either a ship, a wing or a whole team, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing+ship_on_team+waypoint: This can be a reference to either a ship, a wing, any ship on a team, or a waypoint, both present and not yet present. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing+ship_on_team+waypoint: This can be a reference to either a ship, a wing, any ship on a team, or a waypoint, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing+waypoint: This can be a reference to either a ship, a wing, or a waypoint, both present and not yet present. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing+waypoint: This can be a reference to either a ship, a wing, or a waypoint, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
	**; ship+wing+waypoint+none: This can be a reference to either a ship, a wing, a waypoint, both present and not yet present, or none. The script will ~~recieve~~ it as an <tt>oswpt</tt> handle.		**; ship+wing+waypoint+none: This can be a reference to either a ship, a wing, a waypoint, both present and not yet present, or none. The script will receive it as an <tt>oswpt</tt> handle.
	*Syntax: '''''String'''''		*Syntax: '''''String'''''
	}}		}}