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.

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

Jump to bottom

Updating Scarpet docs for Auxiliary.md #1415

Closed
wants to merge 31 commits into from
Closed

Updating Scarpet docs for Auxiliary.md #1415

wants to merge 31 commits into from

Conversation

Ghoulboy78
Copy link
Contributor

@Ghoulboy78 Ghoulboy78 commented Apr 19, 2022 •
edited
Loading

Given that no one seems to be taking this up, and given that I have a bunch of free time, I might as well do this myself. This is a step towards accomplishing the goals outlined in #837.
I will basically go in order down the list and submit prs for all of them.

@Ghoulboy78
Update Auxiliary.md
cb331b2
@Ghoulboy78
Fixing typos
7e18ba8
@Ghoulboy78
Fixing example
f832904
@Ghoulboy78
Added example for markers
d72a4cf
@Ghoulboy78
Adding example to in_dimension()
6bdde70
@Ghoulboy78
Updated create_marker() docs
7f05ee2
@Ghoulboy78
nbt() docs
5d69bb9
@Ghoulboy78
escape_nbt() docs
d21ce22
@Ghoulboy78
parse_nbt() docs
7630ecc
@Ghoulboy78
encode_nbt() docs
accc582
@Ghoulboy78
Merge branch 'master' into update-docs
26351a7
@Ghoulboy78
Squashed commit of the following:
90a4c47 
commit 5b720cb
Author: altrisi <[email protected]>
Date:   Mon Jul 25 23:56:31 2022 +0200

    Don't add `Mod` to CF release to prevent cutting game version

commit feb0dc1
Author: altrisi <[email protected]>
Date:   Fri Jul 29 14:26:00 2022 +0200

    Remove another duplicated mixin entry

    This time for `DistanceManager_spawnChunksMixin`

commit f2a270b
Author: altrisi <[email protected]>
Date:   Fri Jul 29 13:57:32 2022 +0200

    Remove duplicated mixin entry for `ServerLevel_spawnChunksMixin`

commit da06e30
Author: altrisi <[email protected]>
Date:   Fri Jul 29 13:12:26 2022 +0200

    Minor SpawnReporter cleanup (gnembon#1517)

    Mostly removes unused methods

commit 8f7e453
Author: altrisi <[email protected]>
Date:   Fri Jul 29 13:12:09 2022 +0200

    Resolve raw type warnings (gnembon#1516)

    Also very small optimization to hopper counters and removal of redundant casts in `PerimeterDiagnostics`

commit be3c7f2
Author: gnembon <[email protected]>
Date:   Wed Jul 27 22:33:18 2022 +0200

    1.4.83

commit ab45b6f
Author: gnembon <[email protected]>
Date:   Wed Jul 27 22:32:26 2022 +0200

    1.19.1

commit b677cd7
Author: altrisi <[email protected]>
Date:   Mon Jul 25 22:35:24 2022 +0200

    Remove old deprecated `Module` type and subtypes

    They were deprecated in gnembon#1382

commit 97c4cc9
Author: altrisi <[email protected]>
Date:   Mon Jul 25 21:59:50 2022 +0200

    Simplify threading and networking in `download` suggester (gnembon#1512)

    * Simplify threading in download suggester
    This also makes it more robust against race conditions

    * Simplify network requests around app store

commit c08d857
Author: altrisi <[email protected]>
Date:   Sat Jul 23 23:56:13 2022 +0200

    Don't refresh local app store repo on world change

    Relates to gnembon#1508.

commit 6215f83
Author: gnembon <[email protected]>
Date:   Fri Jul 22 18:34:04 2022 +0200

    1.4.82

commit 6d3c4fa
Author: gnembon <[email protected]>
Date:   Fri Jul 22 18:25:43 2022 +0200

    1.19.1-rc2

commit 86ac49c
Author: altrisi <[email protected]>
Date:   Thu Jul 21 15:33:42 2022 +0200

    Fix autocomplete removing all upper-case letters in `script run`

commit a38cd09
Author: ch-yx <[email protected]>
Date:   Thu Jul 21 21:15:30 2022 +0800

    One-line fix for a minor bug about encoding  (gnembon#1368)

commit 0f474f3
Author: Space Walker <[email protected]>
Date:   Thu Jul 21 15:13:20 2022 +0200

    Fix gnembon#1492 (gnembon#1493)

commit c2788f0
Author: altrisi <[email protected]>
Date:   Thu Jul 21 15:12:58 2022 +0200

    Allow modded structures in overlay's `structure` renderer (gnembon#1504)

commit 14325d7
Author: Ghoulboy <[email protected]>
Date:   Thu Jul 21 15:12:44 2022 +0200

    Set ambient properly in modify(entity, 'effect') (gnembon#1501)

commit c919a8c
Author: gnembon <[email protected]>
Date:   Thu Jul 14 00:59:13 2022 +0200

    1.4.81

commit 544857d
Author: gnembon <[email protected]>
Date:   Thu Jul 14 00:57:49 2022 +0200

    1.19.1-pre4

commit 74f56c1
Author: Crec0 <[email protected]>
Date:   Thu Jul 7 02:59:28 2022 -0700

    Fix `query(e, 'brain', 'visible_mobs')` returning null (gnembon#1481)

commit 5a4ceb6
Author: altrisi <[email protected]>
Date:   Thu Jul 7 11:45:37 2022 +0200

    Fix language fallbacks for rules not being available early

    Fixes gnembon#1483

commit d571d61
Author: gnembon <[email protected]>
Date:   Tue Jul 5 10:39:23 2022 +0200

    hmm

commit 8748c7c
Author: gnembon <[email protected]>
Date:   Tue Jul 5 10:22:32 2022 +0200

    1.4.80

commit 0a00734
Author: gnembon <[email protected]>
Date:   Tue Jul 5 10:21:26 2022 +0200

    1.19.1-pre2

commit 6019f81
Author: Ghoulboy <[email protected]>
Date:   Mon Jun 27 20:37:44 2022 +0200

    Making portal_timer and portal_cooldown return portal timer and portal cooldown in that order (gnembon#1476)

    * This error is so dumb I must have done it

    * Update ai_tracker.sc

commit ee4bc33
Author: altrisi <[email protected]>
Date:   Mon Jun 27 14:30:34 2022 +0200

    Remove catchall in action pack update

    Resolves gnembon#1446.

commit b0c94bc
Author: altrisi <[email protected]>
Date:   Mon Jun 27 14:11:20 2022 +0200

    Remove unused `CarpetServer.rand` field

    Resolves gnembon#1429.

commit 41991b0
Author: altrisi <[email protected]>
Date:   Mon Jun 27 14:09:03 2022 +0200

    Improve error message when commands fail to be added and make commands using the new system check for masking (gnembon#1404)

    * Improve error message when command already exists

    * Add app's name to the message

    * Add app name to any command load failure and fix commands from new system masking existing ones

    * Fix duplicated app name in an error

    * Update to recent snapshot changes

commit 286dbea
Author: Fx Morin <[email protected]>
Date:   Mon Jun 27 08:04:11 2022 -0400

    Logger Improvements (gnembon#1399)

    * Null checks & using getOptions

    * Removed useless variable, and made HashMap's final

    * This list & Map should not be modified.
    Plus small changes

    * Small things

    * Fix gnembon#1398

    * Apply suggestions from code review

    * Remove Dead call

    * Handle options being null

    * Remove redundant field explainers

    Those were there for when they were intermediary fields, they now have a proper name

commit 0a972d6
Author: altrisi <[email protected]>
Date:   Mon Jun 27 13:12:15 2022 +0200

    Settings rework and encapsulation (gnembon#1330)

    * Settings rework and encapsulation

    * Settings overhaul 3

    Move everything in the new system to a new API package

    Require rules using the new system to specify descriptions in their translation files

    Implement temporary system on top of current translations to allow that to work properly

    * Fix getRules fallback

    * Final touches to settings refactor

    * Mention that set shouldn't throw and remove comment

    * Change translation keys to unify with translation PR

    * Deprecate printAllRulesToLog to allow using any PrintStream

    * Remove restriction of CarpetRules being Comparable

    And fix overreaction in a deprecation message

    * Bring back user input to rule observers

    * Make Validator deprecation warning not spam on use

    * Remove unneeded abstract methods in CarpetRule already inherited from CarpetRule

    They literally do nothing, don't even force them to be implemented, and may be confusing as to why they're there or as if they are needed to be implemented

    * Fix legacy SettingsManager field not being assigned correctly

    * Finish fixing conflicts from future merge

    * Actually fix remaining conflicts from future merge (missing imports)

    * Import the newer rule in SettingsManager

    * Refactor Validators

    * Don't spam deprecation warnings on custom managers

    * Get out the var

    * Fix missing warning in old rule observers

    * Update src/main/java/carpet/api/settings/Rule.java

    * Remove `@ApiStatus.Experimental` annotations

    * Fix incorrect `@deprecated` javadoc tags

    By removing them given the class is deprecated anyway and else there's too much noise

    * Add missing static import

    * Remove TypedField and use a regular field

    I liked that class tbh, but it's true that it wasn't really needed

    * Move `field` assignment out of for removal

    * Fix not following contract of `type()` returning boxed value

    Previously handled by TypedField

    * Fix few incorrect translation keys

    * Remove resaving of comments when saving config files

    Comments ignoring is still a thing when reading, so `locked` configs for example will keep comments

    * Condense rule load messages in one

    * Only print loaded settings message when at least one setting was changed

    * Fix legacy validator detector

    * Tweak and add more context to response to invalid values

    * Fix strict validator not actually erroring on invalid input

commit f5a92eb
Author: gnembon <[email protected]>
Date:   Wed Jun 15 22:30:25 2022 +0200

    22w24a

commit 81d3b9e
Author: gnembon <[email protected]>
Date:   Tue Jun 7 17:41:02 2022 +0200

    curse

commit 5e5815c
Author: gnembon <[email protected]>
Date:   Tue Jun 7 17:37:35 2022 +0200

    1.19

commit 140cb15
Author: altrisi <[email protected]>
Date:   Wed Jun 1 22:37:39 2022 +0200

    Make newline in release message using zero-width character

    (​)

commit f0fbe32
Author: Dainternetdude <[email protected]>
Date:   Tue Apr 19 13:30:12 2022 -0600

    spelling

commit 486c2ec
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Date:   Wed Jun 1 20:19:32 2022 +0000

    Merge docs for 'Carpet Mod 1.4.78 for 1.19-prerelease-5'

commit 7de976a
Author: Space Walker <[email protected]>
Date:   Wed Jun 1 04:39:22 2022 +0200

    fix gnembon#1454

commit 40af4f2
Author: gnembon <[email protected]>
Date:   Wed Jun 1 21:58:32 2022 +0200

    1.4.78 for 1.19-pre5

commit c10149b
Author: altrisi <[email protected]>
Date:   Sat May 28 13:07:08 2022 +0200

    Publish changelogs to Discord when releasing (gnembon#1428)

    Co-authored-by: Crec0 <[email protected]>

commit 8c7dfa1
Author: Luca Bertozzi <[email protected]>
Date:   Fri May 27 20:24:25 2022 +0200

    Added `__on_chunk_unloaded` scarpet event (gnembon#1451)

    * Fixes gnembon#1403

    * Use concrete type

commit d088ee4
Author: altrisi <[email protected]>
Date:   Fri May 27 19:44:39 2022 +0200

    Set mixin compatibility level to Java 17

commit f18cfb0
Author: altrisi <[email protected]>
Date:   Fri May 27 19:43:45 2022 +0200

    Fix more warnings and do some small optimizations (gnembon#1356)

    * Fix more warnings and do some small optimizations

    * Fix more warnings in ValueConversions

    * Clean up some decompiler names and fix an unnecessary transformation around commands

    * Use (way) more compact data structure for slot map

    * Minor tweaks
    Such as map directly in the collector

    * I hate vanilla javac
    Revert map changes in latest commit

commit e4dc080
Author: altrisi <[email protected]>
Date:   Tue May 24 15:26:31 2022 +0200

    Bump Loader requirement in `fabric.mod.json` too

commit fc54a87
Author: gnembon <[email protected]>
Date:   Mon May 23 23:07:33 2022 +0200

    1.4.77

commit 3a9e3b3
Author: gnembon <[email protected]>
Date:   Mon May 23 23:06:27 2022 +0200

    1.19-pre2

commit 08a6590
Author: altrisi <[email protected]>
Date:   Fri May 20 20:10:32 2022 +0200

    Remove `updateSuppressionCrashFix` and related logger (gnembon#1445)

commit b0a2f2c
Author: gnembon <[email protected]>
Date:   Wed May 18 21:10:15 2022 +0200

    1.4.76

commit 2af763d
Author: gnembon <[email protected]>
Date:   Wed May 18 21:08:32 2022 +0200

    1.19-pre1

commit bbe7701
Author: altrisi <[email protected]>
Date:   Tue May 17 22:06:49 2022 +0200

    Autogenerate refmap field in mixins json and remove empty `server` field

    Not explicitly specifying the refmap here also removes the log entry in dev environments where Mixin complains about missing refmap.

commit 668f309
Author: altrisi <[email protected]>
Date:   Tue May 17 21:55:22 2022 +0200

    Change missed usage of deprecated methods from gnembon#1383

commit 9daf72b
Author: Fx Morin <[email protected]>
Date:   Tue May 17 15:21:46 2022 -0400

    Update `updateSuppressionBlock` for 1.19 (gnembon#1401)

    * Changed Rule: `updateSuppressionBlock` to match new update suppression

    * Make it easier to use

    * Carpets mixin file will be the death of me

    * Renamed `WorldInterface` to `LevelInterface`
    Merged LevelAccessor with LevelInterface

    * Fix issues with 22w14a & resolve issues

    * Add `@Unique` to Level_tickMixin.java

    * Naming, brackets, and description

    * Return null on invalid

    * Fix remaining refactoring issues

commit a60bc38
Author: altrisi <[email protected]>
Date:   Tue May 17 20:11:49 2022 +0200

    Refactor `Module` into a single record type and fix system globals (gnembon#1383)

commit d681cb4
Author: gnembon <[email protected]>
Date:   Fri May 13 11:28:01 2022 +0200

    1.4.75

commit 1a6b1df
Author: gnembon <[email protected]>
Date:   Fri May 13 11:26:47 2022 +0200

    22w19a

commit 648ea01
Author: Ghoulboy <[email protected]>
Date:   Wed May 11 19:56:25 2022 +0200

    Making deepslate generate below y=0, not y=16 (gnembon#1433)

    * Fixes gnembon#1431

    * Updating carpet rule description

    * Making it work for cobbled deepslate

commit e5a3cdf
Author: gnembon <[email protected]>
Date:   Wed May 4 21:35:15 2022 +0200

    1.4.74

commit 217567c
Author: gnembon <[email protected]>
Date:   Wed May 4 21:34:22 2022 +0200

    22w18a

commit 544c1a8
Author: Crec0 <[email protected]>
Date:   Sun May 1 03:29:04 2022 -0700

    Profile categories splitting and descriptions. (gnembon#1375)

    * Split spawning and random ticks into separate categories

    * Split blocks into tile ticks and block events

    * Fix ambiguous call to tick() method
    Fix package private warning

    * fix: add missing sections for tile ticks and block events

    * fix: wrong profiling order

    * feat: add descriptions to profiler categories

    * refactor: replace guava ImmutableMap with jdk Map

    * fix negative time in "rest" category

commit 4662a86
Author: altrisi <[email protected]>
Date:   Fri Apr 29 20:16:03 2022 +0200

    Delete unused `BiomeArrayInterface`

commit c2c127b
Author: gnembon <[email protected]>
Date:   Wed Apr 27 20:17:56 2022 +0200

    1.4.73

commit fc8114b
Author: gnembon <[email protected]>
Date:   Wed Apr 27 20:16:56 2022 +0200

    added 'xpFromExplosions' for xp to always drop from exploding blocks

commit aaf8e7e
Author: gnembon <[email protected]>
Date:   Wed Apr 27 19:51:37 2022 +0200

    22w17a

commit 6111dec
Author: altrisi <[email protected]>
Date:   Thu Mar 17 21:21:44 2022 +0100

    Ease concrete restrictions on Annotated Scarpet API and make instantiating lazy

    Prevents instantiating classes with all annotated methods static, making it also more flexible in that you can put annotated functions near to other API that may be initialized

commit aafb740
Author: altrisi <[email protected]>
Date:   Sun Apr 24 13:30:55 2022 +0200

    Refactor BlockRotator (gnembon#1362)

    - Removes the unused accurate block placement protocol that has been dead there for ages
    - Removes the various rotate clockwise methods in favour of Direction's, that did exactly the same

    No behaviour changes

commit 8346199
Author: Crec0 <[email protected]>
Date:   Sun Apr 24 03:20:39 2022 -0700

    Fix "Unable to determine descriptor" warnings by setting `remap=false` at some locations. (gnembon#1423)

    * set remap=false for "Unable to determine descriptor" warnings

    * remove suppressWarning annotation

commit c1141dd
Author: altrisi <[email protected]>
Date:   Thu Apr 21 18:02:22 2022 +0200

    Fix latest commit about publishing, forgot a few blocks...

commit 91fbb44
Author: altrisi <[email protected]>
Date:   Thu Apr 21 18:00:22 2022 +0200

    Fix publishing warn, go back to loom 0.11 as 0.12 is not yet recommended

    See FabricMC/fabric-example-mod@8adede0

commit 127f4bb
Author: Fx Morin <[email protected]>
Date:   Thu Apr 21 02:17:47 2022 -0400

    Fix carpet not building by updating loom (gnembon#1422)

    * Attempt to fix github issue

commit d03900a
Author: gnembon <[email protected]>
Date:   Thu Apr 21 00:30:35 2022 +0200

    1.4.72

commit 746c854
Author: gnembon <[email protected]>
Date:   Thu Apr 21 00:26:39 2022 +0200

    22w16b with massive Component changes

commit 8101abb
Author: gnembon <[email protected]>
Date:   Wed Apr 20 23:19:59 2022 +0200

    retire extreme behaviours, added moreBlueSkulls

commit b2cb70c
Author: altrisi <[email protected]>
Date:   Wed Apr 20 14:57:50 2022 +0200

    Remove cotton maven given lQF is now on the Gradle plugin portal (gnembon#1420)

    * Bump QuilfFlower version

    * Remove cotton maven given loom QuiltFlower is now in the Gradle plugin portal

commit 8c2ded4
Author: altrisi <[email protected]>
Date:   Wed Apr 20 13:50:44 2022 +0200

    Simplify mod initializers and prevent extensions from mixing into Carpet just to register themselves (gnembon#1396)

commit 83b0fb1
Author: altrisi <[email protected]>
Date:   Wed Apr 20 13:29:31 2022 +0200

    Show local type in exception hover tooltips (gnembon#1397)

commit 80a5342
Author: altrisi <[email protected]>
Date:   Wed Apr 20 13:27:25 2022 +0200

    Make scarpet internal and control flow exceptions stackless (gnembon#1392)

commit 7686147
Author: altrisi <[email protected]>
Date:   Wed Apr 20 13:01:58 2022 +0200

    Add support for formatted names in `create_marker` (gnembon#1413)
@Ghoulboy78
Updating docs for encode_nbt
a9bb758
@Ghoulboy78
Added example for load_app_data()
14f9a33
@Ghoulboy78
Updating docs for load_app_data()
44d8a09
@Ghoulboy78
Updating docs for store_app_data()
bec0a6c
@Ghoulboy78
Added notice about broken dimension stuff
c681218
@Ghoulboy78
Added examples for tick_time()
a7b742d
@Ghoulboy78
Updated docs for get_mob_counts()
a9531ca
@Ghoulboy78
Added example for day_time()
9e3aea2
@Ghoulboy78
Copy link
Contributor Author

oh shit, I did not realise what merging with upstream would do. Imma just make a new PR, this is a mess...

@Ghoulboy78 Ghoulboy78 closed this Aug 5, 2022
@Ghoulboy78 Ghoulboy78 deleted the update-docs branch August 5, 2022 08:18
@Ghoulboy78 Ghoulboy78 mentioned this pull request Aug 5, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@altrisi altrisi altrisi left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Ghoulboy78 @altrisi