archives/AIDScripting
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update on isNotHidden flag

Browse source
This commit is contained in:
Branleaf 2022-01-30 23:29:02 +00:00 • committed by GitHub
parent a76fe099b9
commit 038cf3678c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -51,12 +51,12 @@ Called each time the model generates an output and has the opportunity to modify
You can read from the `worldInfo` parameter and modify the World Info of an adventure using the following functions - these are not methods of worldInfo, however:
You can modify worldInfo with the below functions (not methods of worldInfo):
* addWorldEntry(keys, entry, isNotHidden = false)
* addWorldEntry(keys, entry)
* removeWorldEntry(index) - **Note: At the time of writing, this is known to be bugged and likely will not work. This note will be removed when this is no longer the case.**
* updateWorldEntry(index, keys, entry, isNotHidden = false)
* updateWorldEntry(index, keys, entry)
Things to note:
* `isNotHidden` is a now-removed feature that would hide world info from players of an adventure when set to false. At the time of writing, use of this is still required for these functions but it does not do anything.
* `isNotHidden` is a now-removed feature that would hide world info from players of an adventure when set to false. You may notice an extra argument in old world info management scripts that use addWorldEntry and updateWorldEntry - this is why. It won't break the script, but it no longer does anything.
* `index` in the above functions refers to the position of a world info entry in the `worldInfo` object, which is an array of objects representing your world info.
## State