Skip to content

Making it easier to integrate PlanetsLib into existing planets with vanilla-style orbit information #40

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
nicholasgower wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Making it easier to integrate PlanetsLib into existing planets with vanilla-style orbit information #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e135e48
compat: Added additional step to PlanetsLib:extend that restructures …
nicholasgower Feb 10, 2025
cd0e020
Update changelog.txt
nicholasgower Feb 10, 2025
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
1 change: 1 addition & 0 deletions changelog.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Version: 1.2.7
Date: ????
Changes:
- Planets with vanilla-style orbit fields can now be passed to PlanetsLib:extend without crashing.
---------------------------------------------------------------------------------------------------
Version: 1.2.6
Date: 2025-02-07
Expand Down
46 changes: 38 additions & 8 deletions lib/planet.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ local orbits = require("lib.orbits")
local Public = {}

function Public.extend(config)
Public.default_extend_fields(config)
Public.verify_extend_fields(config)

local planet = {}



local distance, orientation = orbits.get_absolute_polar_position_from_orbit(config.orbit)

planet.distance = distance
Expand All @@ -16,6 +19,8 @@ function Public.extend(config)
planet[k] = v
end



if planet.orbit.parent then --Adds encoded parent body to surface properties.
if planet.orbit.parent.type == "planet" then
if data.raw["planet"][config.orbit.parent.name] then
Expand All @@ -36,37 +41,62 @@ function Public.is_space_location(planet)
return planet.type == "planet" or planet.type == "space-location"
end

function Public.default_extend_fields(config) --Adds default values when values are empty. This step does not seek to assert anything.
--Allows planet objects with orbits formatted according to vanilla structure to be passed to PlanetsLib without any modifications.
--Will not prevent planets with distance/orientation both defined in root and orbit from crashing.
if (config.orbit == nil) then
config.orbit = {}
end
if config.orbit then
if config.orbit.distance == nil and config.distance then
config.orbit.distance = config.distance
config.distance = nil
end
if config.orbit.orientation == nil and config.orientation then
config.orbit.orientation = config.orientation
config.orientation = nil
end
if config.orbit.parent == nil then --Default planet orbit parent mirroring vanilla planets. Before this was added, the library would crash when parent was nil.
config.orbit.parent = {
type = "space-location",
name ="star",
}
end
end

end

-- TODO: Add checks to ensure the structure of orbit is correct.
function Public.verify_extend_fields(config)
if not Public.is_space_location(config) then
error(
"PlanetsLib:extend() - extend only takes a planet or space-location prototype. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
"Error with space-location \""..config.name.."\": PlanetsLib:extend() - extend only takes a planet or space-location prototype. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
)
end
if not config.orbit then
error(
"PlanetsLib:extend() - 'orbit' field is required. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
"Error with space-location \""..config.name.."\": PlanetsLib:extend() - 'orbit' field is required. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
)
end
if not Public.is_space_location(config.orbit.parent) then
error(
"PlanetsLib:extend() - 'orbit.parent' must be a space location. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
"Error with space-location \""..config.name.."\": PlanetsLib:extend() - 'orbit.parent' must be a space location. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
)
end

if config.distance then
if config.distance or not config.orbit.distance then
error(
"PlanetsLib:extend() - 'distance' should be specified in the 'orbit' field. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
"Error with space-location \""..config.name.."\": PlanetsLib:extend() - 'distance' should be specified in the 'orbit' field. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
)
end
if config.orientation then
if config.orientation or not config.orbit.distance then
error(
"PlanetsLib:extend() - 'orientation' should be specified in the 'orbit' field. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
"Error with space-location \""..config.name.."\": PlanetsLib:extend() - 'orientation' should be specified in the 'orbit' field. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
)
end
if not config.orbit.parent then
error(
"PlanetsLib:extend() - 'orbit.parent' field is required with an object containing 'type' and 'name' fields. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
"Error with space-location \""..config.name.."\": PlanetsLib:extend() - 'orbit.parent' field is required with an object containing 'type' and 'name' fields. See the PlanetsLib documentation at https://mods.factorio.com/mod/PlanetsLib."
)
end
end
Expand Down