Skip to content

Fix reference to getVariables in docs #174

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.

Sign up for GitHub

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

Open
klausfl wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix reference to getVariables in docs #174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/functions-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

```
// returns a list of all the variables defined in the map.
getAllVariables(): Promise<Map<string, VariableDescriptor>>
getVariables(): Promise<Map<string, VariableDescriptor>>
```

Variables are returned as a Map. The key is the name of the variable, the value is an object representing the variable.
Expand All @@ -17,9 +17,9 @@ You can fetch individual properties defined in Tiled for this variable using thi
For instance:

```typescript
import { getAllVariables, VariableDescriptor } from '@workadventure/scripting-api-extra';
import { getVariables, VariableDescriptor } from '@workadventure/scripting-api-extra';

const variables = await getAllVariables();
const variables = await getVariables();
console.log(variables['my_variable'].properties.getOne('persist'));
```

Expand Down