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.

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

Port physics interpolation docs from 3.6 #10359

Merged
merged 1 commit into from
Dec 4, 2024

Conversation

skyace65
Copy link
Contributor

@skyace65 skyace65 commented Dec 1, 2024

This is a copied and modified version of the physics interpolation docs from the 3.6 branch of the documentation. 2D physics interpolation exists in 4.3, however 3D interpolation only exists in 4.4 so this can't be cherry picked.

Changes I've made compared to the 3.6 version of these pages

  • Changed "Camera" references to "Camera3D"
  • Changed "Spatial" referenced to "Node3D"
  • Changed multi-mesh method name to reflect 4.4 version of that method
  • changed "phsyics fps" to "physics ticks per second"
  • replaced reference to the method "set_as_toplevel" to the property "top_level". The method doesn't seem to exist anymore
  • Re-did 2 editor images for 4.4, converted the other 2 to webp
  • Applied suggestions from AThousandShips and LawnJelly in their review of PR Add physics interpolation docs to 4.3 #9738.
  • Broke up lines of text so they're not extremely long.

@skyace65 skyace65 added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation topic:physics labels Dec 1, 2024
@skyace65 skyace65 added this to the 4.4 milestone Dec 1, 2024
@skyace65 skyace65 force-pushed the PhysicsInterpolation branch 5 times, most recently from 6bd82eb to 958b4c9 Compare December 1, 2024 16:19
@skyace65 skyace65 marked this pull request as ready for review December 1, 2024 16:23
and the smoothest possible experience.

Exceptions to automatic physics interpolation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if it matters for rendering the page, but at least for consistency, we should use the order for header syntax that is standard in other pages:

Page title
==========

Header
------

Sub-header
~~~~~~~~~~

Sub-sub-header
^^^^^^^^^^^^^^

This page uses ^^^ for everything, so all those should use --- instead. And you should consider using subheaders with ~~~ for some of the headers below Cameras, since they're all meaningfully related. UNLESS you are intentionally trying to keep everything at the same header level so it shows up in the sidebar.

The other pages here need similar changes. If you want specific suggestions for exactly which header syntax to use for each I can make individual suggestions for them.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can also be done in a later PR without breaking translations, so feel free to ignore and defer this one

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll implement this, and change all the ^^^^ to ~~~~

Camera every frame in ``_process()`` to look at a target node (such as the player).

But there is a problem. If we use the traditional ``get_global_transform()`` on a
Camera "target" Node, this transform will only focus the Camera on the target *at
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Camera "target" Node, this transform will only focus the Camera on the target *at
Camera "target" node, this transform will only focus the Camera on the target *at

"Node" usually not capitalized in most cases since its very common.
Honestly "Camera" may or may not need to be capitalized either thoughout this page, but that case is more subjective and I understand why it currently is capitalized.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Camera" was probably capitalized because that was what "Camera3D" was named in 3.x. I'll go through and change it as applicable.

@tetrapod00
Copy link
Contributor

First batch of suggestions. I'll try to come back and look again after building this locally.

We could probably merge this as-is though, since it is pretty good already and already exists in the 3.6 docs. We definitely shouldn't delay this to after the release of 4.4

@skyace65 skyace65 force-pushed the PhysicsInterpolation branch from 958b4c9 to 5e7cddb Compare December 2, 2024 02:07
@skyace65
Copy link
Contributor Author

skyace65 commented Dec 2, 2024

I've applied changes based on tetrapod's review. The one section that used uppercase "Camera" everywhere is now using either "Camera3D" or "camera". I'd appreciate someone else looking it over to make sure everything flows right, it seems kinda weird to switch back and forth.

@skyace65 skyace65 force-pushed the PhysicsInterpolation branch from 5e7cddb to 6b4a2c9 Compare December 2, 2024 23:31
@skyace65
Copy link
Contributor Author

skyace65 commented Dec 2, 2024

Fixed

@mhilbrunner mhilbrunner merged commit 160b937 into godotengine:master Dec 4, 2024
1 check passed
@mhilbrunner
Copy link
Member

Thank you, great work! Merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:physics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants