Skip to content
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

Jump to bottom

[Planet] Document collision size limitation on resize #1960

Closed
wants to merge 1 commit into from
Closed

[Planet] Document collision size limitation on resize #1960

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/spaceObjects/planet.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ REGISTER_SCRIPT_SUBCLASS(Planet, SpaceObject)
/// - its atmosphere radius to 1.2x this value
/// - its collision size to a function of this value and the planet's z-position
/// Defaults to 5000 (5U).
/// Changing a planet's radius after its initial network replication does _not_ update its collision size on clients, resulting in inconsistent behavior. See issue #1957.
/// Example: planet:setPlanetRadius(2000)
REGISTER_SCRIPT_CLASS_FUNCTION(Planet, setPlanetRadius);
/// Sets this Planet's collision radius.
Expand All @@ -158,6 +159,7 @@ REGISTER_SCRIPT_SUBCLASS(Planet, SpaceObject)
/// Sets the z-position of this Planet, the distance by which it's offset above (positive) or below (negative) the movement plane.
/// This value also modifies the Planet's collision radius.
/// Defaults to 0.
/// Changing a planet's z-position after its initial network replication does _not_ update its collision size on clients, resulting in inconsistent behavior. See issue #1957.
/// Example: planet:setDistanceFromMovementPlane(-500) -- sets the planet 0.5U below the movement plane
REGISTER_SCRIPT_CLASS_FUNCTION(Planet, setDistanceFromMovementPlane);
/// Sets this Planet's axial rotation time, in degrees per tick.
Expand Down