Skip to content

Commit

Permalink
Manual changes to the API file
Browse files Browse the repository at this point in the history
Made ReinforceWithTransport()'s `cargoTypes` parameter nullable because it should be but we have no good way of automatically marking it as such. See OpenRA PR 20609.
(based on commit 35cb21a)
  • Loading branch information
penev92 authored and Mailaender committed Oct 14, 2023
1 parent aa6edac commit 0f2752d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion api/dev/library/OpenRA.lua
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ Reinforcements = {
--- Send reinforcements in a transport. A transport can be a ground unit (APC etc.), ships and aircraft. The first member of the entryPath array will be the spawnpoint for the transport, while the last one will be its destination. The last member of the exitPath array is be the place where the transport will be removed from the game. When the transport has reached the destination, it will unload its cargo unless a custom actionFunc has been supplied. Afterwards, the transport will follow the exitPath and leave the map, unless a custom exitFunc has been supplied. actionFunc will be called as actionFunc(Actor transport, Actor[] cargo). exitFunc will be called as exitFunc(Actor transport). dropRange determines how many cells away the transport will try to land if the actual destination is blocked (if the transport is an aircraft). Returns a table in which the first value is the transport, and the second a table containing the deployed units.
---@param owner player
---@param actorType string
---@param cargoTypes string[]
---@param cargoTypes string[]|nil
---@param entryPath cpos[]
---@param exitPath? cpos[]
---@param actionFunc? function
Expand Down
2 changes: 1 addition & 1 deletion api/release-20231010/library/OpenRA.lua
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,7 @@ Reinforcements = {
--- Send reinforcements in a transport. A transport can be a ground unit (APC etc.), ships and aircraft. The first member of the entryPath array will be the spawnpoint for the transport, while the last one will be its destination. The last member of the exitPath array is be the place where the transport will be removed from the game. When the transport has reached the destination, it will unload its cargo unless a custom actionFunc has been supplied. Afterwards, the transport will follow the exitPath and leave the map, unless a custom exitFunc has been supplied. actionFunc will be called as actionFunc(Actor transport, Actor[] cargo). exitFunc will be called as exitFunc(Actor transport). dropRange determines how many cells away the transport will try to land if the actual destination is blocked (if the transport is an aircraft). Returns a table in which the first value is the transport, and the second a table containing the deployed units.
---@param owner player
---@param actorType string
---@param cargoTypes string[]
---@param cargoTypes string[]|nil
---@param entryPath cpos[]
---@param exitPath? cpos[]
---@param actionFunc? function
Expand Down

0 comments on commit 0f2752d

Please sign in to comment.