Skip to content

Update UIPageLayout.yaml #1206

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ProtoValence
Copy link
Contributor

@ProtoValence ProtoValence commented Aug 14, 2025

Why are the changes being made?

Changes

In order to follow up with this DevForum bug report, I'm updating documentation surround UIPageLayout to be more descriptive. More specifically, I've updated the description for the PageEnter and PageLeave events, to state that they are only used to determine whether a page has become visible on the screen.

It also provides an alternative method for determining when a page has changed (which is likely to apply to a lot of, if not most developers.

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.

What changes are being made?

  • Clarifies UIPageLayout.PageEnter and PageLeave event docs in UIPageLayout.yaml, explaining visibility, rendering, and alternatives for page change detection.

  • AI-assisted summary reviewed and verified by author

@ProtoValence ProtoValence requested a review from a team as a code owner August 14, 2025 17:35
@github-actions github-actions bot added engine reference Changes the Engine API Reference documentation changes requested This pull request has changes requested prior to merging labels Aug 14, 2025
@IgnisRBX IgnisRBX marked this pull request as draft August 14, 2025 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changes requested This pull request has changes requested prior to merging engine reference Changes the Engine API Reference documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant