Skip to content

Lua isDockLeader function #7286

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

Merged
wookieejedi merged 2 commits into from
Mar 17, 2026
+17 −0
Merged

Lua isDockLeader function #7286

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ca2e85
lua isDockLeader function
MjnMixael Mar 14, 2026
421edb9
address nitpicks
MjnMixael Mar 16, 2026
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
17 changes: 17 additions & 0 deletions code/scripting/api/objs/ship.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2884,6 +2884,23 @@ ADE_FUNC(jettison, l_Ship, "number jettison_speed, [ship... dockee_ships /* All
return jettison_helper(L, docker_objh, jettison_speed, 2);
}

ADE_FUNC(isDockLeader, l_Ship, nullptr, "Returns whether this ship is currently docked and is the dock leader for its docked group", "boolean", "True if this ship is docked and is the dock leader, false otherwise, nil if ship handle is invalid")
{
object_h* objh = nullptr;

if (!ade_get_args(L, "o", l_Ship.GetPtr(&objh)))
return ADE_RETURN_NIL;

if (objh == nullptr || !objh->isValid())
return ADE_RETURN_NIL;

if (!object_is_docked(objh->objp()))
return ADE_RETURN_FALSE;

auto shipp = &Ships[objh->objp()->instance];
return shipp->flags[Ship::Ship_Flags::Dock_leader] ? ADE_RETURN_TRUE : ADE_RETURN_FALSE;
}

ADE_FUNC(AddElectricArc, l_Ship, "vector firstPoint, vector secondPoint, number duration, number width, [number segment_depth, boolean persistent_points]",
"Creates an electric arc on the ship between two points in the ship's reference frame, for the specified duration in seconds, and the specified width in meters. Optionally, "
"specify the segment depth (the number of times the spark is divided) and whether to generate a set of arc points that will persist from frame to frame.",
Expand Down
Loading