Remove LSL-specific state machine events from SLua documentation #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Modified generate-docs.js to skip state_entry, state_exit, and timer when generating SLua event pages - Removed existing state_entry.mdx, state_exit.mdx, and timer.mdx from SLua reference - These events are LSL-specific and don't apply to SLua's event model - LSL documentation still includes all 43 events; SLua now has 40 events Co-authored-by: bennettgoble <[email protected]>
Store event count in a variable to avoid duplicate Object.keys() calls Co-authored-by: bennettgoble <[email protected]>
Copilot
AI
changed the title
[WIP] Remove state_entry and state_exit from SLua documentation
Remove LSL-specific state machine events from SLua documentation
Nov 21, 2025
bennettgoble
suggested changes
Nov 21, 2025
Contributor
bennettgoble
left a comment
bennettgoble
left a comment
There was a problem hiding this comment.
@copilot add the timer event back, we want to keep this in slua documentation.
Keep timer event in SLua docs; only exclude state_entry and state_exit which are specific to LSL's state machine model Co-authored-by: bennettgoble <[email protected]>
Contributor
Author
Updated example usage and notes for the timer event in SLua/Luau.
bennettgoble
approved these changes
Nov 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SLua uses a different event model than LSL and does not support LSL's state machine. The events
state_entryandstate_exitare LSL-specific and should not appear in SLua reference documentation. Thetimerevent is supported in SLua and has been retained.Changes
scripts/generate-docs.js: AddedlslOnlyEventsfilter to skip state machine events (state_entryandstate_exit) during SLua documentation generationstate_entry.mdxandstate_exit.mdxfromsrc/content/docs/script/slua-reference/events/timer.mdxin SLua documentation as this event is supportedLSL documentation retains all 43 events. SLua documentation now correctly shows 41 events (excluding only
state_entryandstate_exit).Original prompt
<issue_description>SLua does not use LSL's state machine model. The state_entry and state_exit events are LSL-specific and should likely be removed from the SLua reference documentation.
Possible solution:
state_entry,state_exitandtimerevents when generating SLua event pages using generate-docs.jsComments on the Issue (you are @copilot in this section)
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.