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

Additional clarification on GuiBase2d.AbsolutePosition #956

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Cens-r
Copy link

@Cens-r Cens-r commented Dec 26, 2024

Changes

To avoid potentially misleading vagueness, this PR makes minor changes to the note's wording within the description of the AbsolutePosition property of GuiBase2d elements. Clarification that the property will always represent the top-left corner of a GuiBase2d, regardless of the ambiguous "influences" AnchorPoint has on the AbsolutePosition.

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

Proposed change to the AbsolutePosition property's note: "Note that the object's AnchorPoint influences AbsolutePosition."

The note, while true, is a bit misleading, and more clarification is needed to ensure users know AbsolutePosition always represents the top-left corner of a GuiBase2d element.
@Cens-r Cens-r requested a review from a team as a code owner December 26, 2024 03:38
@github-actions github-actions bot added the engine reference Changes the Engine API Reference documentation label Dec 26, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hi @Cens-r, thanks so much for helping improve the Roblox creator documentation! Our technical writing team will review your pull request soon. In the meantime, please ensure you've read through the README.md, contribution guidelines, and style recommendations.

Comment on lines 26 to 27
renders as a result of its ancestors' sizes and positions. Note that the
object's `Class.GuiObject.AnchorPoint|AnchorPoint` influences
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
renders as a result of its ancestors' sizes and positions. Note that the
object's `Class.GuiObject.AnchorPoint|AnchorPoint` influences
renders as a result of its ancestors' sizes and positions. Note that

Comment on lines +28 to +29
`Class.GuiBase2d.AbsolutePosition|AbsolutePosition`, but it will always
represent the top-left corner of the `Class.GuiBase2d` element.
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
`Class.GuiBase2d.AbsolutePosition|AbsolutePosition`, but it will always
represent the top-left corner of the `Class.GuiBase2d` element.
`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` always
represents the top-left corner of the `Class.GuiBase2d` element.

@IgnisRBX
Copy link
Contributor

IgnisRBX commented Jan 6, 2025

IMHO we can just omit mention of AnchorPoint here, since that changes the position of the element on screen and does (as previously stated) affect AbsolutePosition, but the main takeaway is that AbsolutePosition represents the top-left corner of the object.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engine reference Changes the Engine API Reference documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants