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

Notify Documentation no longer accurate #5375

Open
HorBro38 opened this issue Feb 20, 2024 · 5 comments
Open

Notify Documentation no longer accurate #5375

HorBro38 opened this issue Feb 20, 2024 · 5 comments
Labels
documentation An issue or pull request ONLY affecting documentation. (its content, not its generation tools)

Comments

@HorBro38
Copy link

The actual Notify Screen and the one in the documentation are no longer the same. Here's the one from the docs ( https://www.renpy.org/doc/html/screen_special.html#notify ):

screen notify(message):
    zorder 100

    text message at _notify_transform

    # This controls how long it takes between when the screen is
    # first shown, and when it begins hiding.
    timer 3.25 action Hide('notify')

transform _notify_transform:
    # These control the position.
    xalign .02 yalign .015

    # These control the actions on show and hide.
    on show:
        alpha 0
        linear .25 alpha 1.0
    on hide:
        linear .5 alpha 0.0

And here's the actual one from the latest build:

screen notify(message):

    zorder 100
    style_prefix "notify"

    frame at notify_appear:
        text "[message!tq]"

    timer 3.25 action Hide('notify')


transform notify_appear:
    on show:
        alpha 0
        linear .25 alpha 1.0
    on hide:
        linear .5 alpha 0.0
@Gouvernathor
Copy link
Member

Duplicate of #3000 - that page is not supposed to show the screens of the started game template but merely workable screens that would fit their purpose.

@Gouvernathor Gouvernathor added the documentation An issue or pull request ONLY affecting documentation. (its content, not its generation tools) label Feb 20, 2024
@HorBro38
Copy link
Author

That's really unfortunate, many take them as how they should be - just had a user think their notify screen was wrong because of this.

@Gouvernathor
Copy link
Member

We can see this as an uncanny vally issue : maybe they would be better off as radically different from the ones in the template.

@HorBro38
Copy link
Author

I think a larger message at the top (possibly with the orange warning/notification text?) that clarified that the screens listed here differ from what's actually in engine may be a good idea.

@HorBro38
Copy link
Author

I would especially remove the line "The default notify screen, and its associated transform, are:" regardless then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An issue or pull request ONLY affecting documentation. (its content, not its generation tools)
Projects
None yet
Development

No branches or pull requests

2 participants