Add new docs about assigning variables to global scope #186
Conversation
This file contains 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
lolleko
reviewed
Jul 13, 2024
docs/assigning-global-variables.md
Outdated
|
|
||
| import { SideBySide } from "@site/src/components/SideBySide"; | ||
|
|
||
| In some Lua environments, the host application expects you to define some global variables or functions as part of the API. For example, some engines might allow you to define some event handlers in your Lua, that will be called by the engine when different events happen: |
There was a problem hiding this comment.
Nit
Suggested change
| In some Lua environments, the host application expects you to define some global variables or functions as part of the API. For example, some engines might allow you to define some event handlers in your Lua, that will be called by the engine when different events happen: | |
| In some Lua environments, the host application expects you to define global variables or functions as part of the API. For example, some engines might allow you to define some event handlers in your Lua, that will be called by the engine when different events happen: |
docs/assigning-global-variables.md
Outdated
|
|
||
| </SideBySide> | ||
|
|
||
| This means we need some extra helper code to correctly register these global variables so your environment can access them. |
There was a problem hiding this comment.
Nit
Suggested change
| This means we need some extra helper code to correctly register these global variables so your environment can access them. | |
| This means we need extra helper code to correctly register these global variables so your environment can access them. |
docs/assigning-global-variables.md
Outdated
|
|
||
| ## Assigning to globals with declarations | ||
|
|
||
| The main weakness of the above methods is that you can declare any string, not protecting you from typos, and not giving any kind of editor support. This is fine if there are only a few such registrations that need to be done, but is somewhat error prone. |
There was a problem hiding this comment.
For the first two options you also don't have to specify a string, right?
Also we should probably mention these issues earlier. Think it is important to highlight that editor support/type safety goes out the window as soon as you use any of the above solutions.
docs/assigning-global-variables.md
Outdated
Comment on lines
177
to
199
| ## Assigning to globals with declarations | ||
|
|
||
| The main weakness of the above methods is that you can declare any string, not protecting you from typos, and not giving any kind of editor support. This is fine if there are only a few such registrations that need to be done, but is somewhat error prone. | ||
|
|
||
| An alternative method would be to explicitly declare the global variables in a declarations file: | ||
|
|
||
| ```ts | ||
| declare var OnStart: (this: void) => void; | ||
| declare var OnStateChanged: (this: void, newState: State) => void; | ||
| ``` | ||
|
|
||
| You can then assign to these functions as if they were global variables: | ||
|
|
||
| ```typescript | ||
| OnStart = () => { | ||
| // start event handling code | ||
| }; | ||
| OnStateChanged = (newState: State) => { | ||
| // state change event handler code | ||
| }; | ||
| ``` | ||
|
|
||
| This of course only works if you know the names of the global variables beforehand, if these names are dynamic, consider using one of the other methods instead. |
There was a problem hiding this comment.
I think this should be the first option.
As this is the "most correct/safe" option. The other ones maybe more convenient, but also slightly more hacky.
docs/assigning-global-variables.md
Outdated
Comment on lines
181
to
186
| An alternative method would be to explicitly declare the global variables in a declarations file: | ||
|
|
||
| ```ts | ||
| declare var OnStart: (this: void) => void; | ||
| declare var OnStateChanged: (this: void, newState: State) => void; | ||
| ``` |
There was a problem hiding this comment.
Does this need to be declared in a declarations file or can this be declared in any ts file?
Perryvw
changed the title
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.
No description provided.