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

Events update #43

Merged
merged 4 commits into from
Apr 4, 2024
Merged

Events update #43

merged 4 commits into from
Apr 4, 2024

Conversation

michaelthatsit
Copy link
Member

Updated documentation to reflect new update events.

@michaelthatsit michaelthatsit requested a review from hanbollar April 3, 2024 22:26
Copy link

render bot commented Apr 3, 2024

Copy link
Contributor

@hanbollar hanbollar left a comment

Choose a reason for hiding this comment

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

As long as you address the notes, then lgtm

Comment on lines 98 to 108
---

# Supported MouseEvents (in XR and 2D)

## `touchend`
These are standard MouseEvents and _should_ behave as they would on any webpage.

Triggered whenever the controller's trigger button or pinch gesture is released, or when the user stops touching an entity.
## `click`

Origin: the target element
## `mouseover`

## `mouseout`
Copy link
Contributor

Choose a reason for hiding this comment

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

this should probably be its own event page instead of being hidden at the bottom - just adding the file in the folder directly should update the section on the left so there's nothing more involved to do other than that

Copy link
Contributor

Choose a reason for hiding this comment

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

also make sure to add the same sections like you did for the above interaction items

description

origin:

detail:

  • ...

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah then I might leave these undocumented, we don't add any more detail to them than the standard MouseEvents implementation.

Copy link
Member Author

Choose a reason for hiding this comment

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

But we will in a future update when I refactor the ControlSystem

Copy link
Contributor

@hanbollar hanbollar Apr 3, 2024

Choose a reason for hiding this comment

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

sounds good -then this isnt a pr blocker, just leave them without the descriptions, but on a new page still- and make an open issue in the documentation repo as a reminder for when we get to that ~

@michaelthatsit michaelthatsit merged commit 1a389ba into main Apr 4, 2024
1 check passed
@michaelthatsit michaelthatsit deleted the events-update branch April 4, 2024 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants