Be better at documenting #5

NeunEinser · 2021-01-28T21:48:19Z

There is no documentation.
git gud

This documents most declarations in the init functions and also adds documentation for the functions themselves. The storage bingo:main was renamed to bingo:items Setup lobby is no longer executed positioned 0 0 0, but instead the commands used in that function are executed on global coordinates. Work towards #5

This documents the tick and set_player_id function (work towards #5). Both functions are moved to the tick subfolder now.

This adds documentation to all util ffunctions. Work towards #5 Additionally, some names in match_uuid changed.

Adds documentation to prefrences. Work towards #5

This documents the card_frames sub folder. Furthermore, temporary storages are renamed to follow the new scheme (Work towards #5) and the tag bingo.unmark has the inverse functionality and is now called bingo.toggle_on.

This documents the card_frames sub folder. (Work towards #5) Furthermore, temporary storages are renamed to follow the new scheme (Work towards #4) and the tag bingo.unmark has the inverse functionality and is now called bingo.toggle_on.

This refactors command queue to be easier to understand and removes some unnecessary functions. Everything in there is now also documented (Work towards #5) and names are changed to follow #4.

This documents card display functions (Work towards #5) score_holder name $y follows new rules for temporary score holder names and is now called $card_display/display_card.y.

This documents the function responsible for setting signs in the lobby. Work towards #5

This documents the full init function and adds declarations for every variable used for the api. (Work towards #5) Other functions are not yet documented. Some objective names where renamed to follow new conventions. (Work towards #4)

This moves internal scores used by the timer from 91.timer.main to 91.timer.intern. The sole constant (value 60) was also moved from 91.timer.const to the new objective, and the const objective was removed. All internal score holders are also properly documented now (Work towards #5)

This documents all functions and declarations in item detection (Work towards #5). This also renames some tremporary declarations to follow new conventions better (work towards #4).

Kri5t0fK · 2022-02-13T16:32:35Z

Is lacking @context here?

bingo/data/bingo/functions/game/start/set_spawn.mcfunction

Lines 1 to 6 in c8e309b

    
           #> bingo:game/start/set_spawn 
        
           # 
        
           # Sets the spawnpoint for all players and spawns a marker aec incase the player 
        
           # respawns in the overworld 
        
           # 
        
           # @within function bingo:game/start/countdown

from here (at @a[...):

bingo/data/bingo/functions/game/start/countdown.mcfunction

Line 9 in c8e309b

    
           execute if score $start_game.countdown bingo.schedule matches 3 at @a[predicate=bingo:is_in_game, limit=1] align xz positioned ~0.5 ~ ~0.5 run function bingo:game/start/set_spawn

Kri5t0fK · 2022-02-17T10:16:57Z

Is `#bingo:post_register_items` the same thing as `#bingo:post_registration`?

storage bingo:items categories[].items - mentions #bingo:post_register_items

bingo/data/bingo/functions/init/init.mcfunction

Lines 54 to 56 in d8fc361

    
           	# items: (Compund List) (readonly) List of all items this category has. Entries 
        
           	# 	have the same structure as in the items array. Will be created 
        
           	# 	automatically, after #bingo:post_register_items ran.

storage bingo:registries - mentions both:

bingo/data/bingo/functions/init/init.mcfunction

Lines 67 to 69 in d8fc361

    
           	# To execute an action before the registries are processed but after all active 
        
           	# extension packs have registered everything, add a function to the function tag 
        
           	# #bingo:post_registration

bingo/data/bingo/functions/init/init.mcfunction

Lines 82 to 84 in d8fc361

    
           	# In order to modify existing items, either added by the default bingo datapack, 
        
           	# or added by another extension pack, please use a function registered to the 
        
           	# function tag #bingo:post_register_items

no declaration for #bingo:post_register_items

#bingo:post_registration declaration:

bingo/data/bingo/functions/init/init.mcfunction

Lines 1119 to 1128 in d8fc361

    
           	#> 
        
           	# Function tag for doing actions after the item registration, but before the 
        
           	# items are duplicated into the categories array. 
        
           	# 
        
           	# You may use this function tag for modifing existing items from the default 
        
           	# bingo item pool or from other extensio packs. 
        
           	# 
        
           	# @api 
        
           	#declare tag/function bingo:post_registration 
        
           	function #bingo:post_registration

Kri5t0fK · 2022-02-17T10:22:45Z

Maybe add info that `bingo:items` are generated from `bingo:registries`?

bingo/data/bingo/functions/init/init.mcfunction

Lines 24 to 25 in d8fc361

    
           	# This storage is used to keep track of all items that are available in 
        
           	# Minecraft: Bingo.

bingo/data/bingo/functions/init/init.mcfunction

Lines 1131 to 1146 in d8fc361

    
           #region initialize items 
        
           	#> 
        
           	# @within function bingo:init/* 
        
           	#declare storage tmp.bingo:init 
        
           	# initialize items 
        
           	data modify storage tmp.bingo:init items set from storage bingo:registries items 
        
           	data modify storage bingo:items categories set from storage bingo:registries categories 
        
           	data remove storage bingo:items items 
        
           	function bingo:init/initialize_items 
        
           	execute unless data storage bingo:items activeTags run data modify storage bingo:items activeTags set value ["bingo:default"] 
        
           	# Schedule to avoid maxCommandChainLength being hit (setting it in init doesn't work the first time) 
        
           	schedule function bingo:util/apply_active_item_tags 1t 
        
           #endregion

Kri5t0fK · 2022-02-18T19:13:08Z

Add more info about `strict mode` (description, only used in MP)

bingo/data/bingo/functions/init/init.mcfunction

Lines 908 to 913 in d8fc361

    
           		#> 
        
           		# Whether strict mode is turned on 
        
           		# 
        
           		# @internal 
        
           		#declare score_holder $strict_mode 
        
           		scoreboard players add $strict_mode bingo.settings 0

Kri5t0fK · 2022-02-18T19:17:24Z

Maybe encapsulate `consts` in `#region consts`?

bingo/data/bingo/functions/init/init.mcfunction

Lines 935 to 947 in d8fc361

#>

# Whether the card needs to be updated

#

# @internal

#declare score_holder $update_card

#>

# @public

#declare score_holder -2

scoreboard players set -2 bingo.const -2

#>

# @public

#declare score_holder -1

scoreboard players set -1 bingo.const -1

Kri5t0fK · 2022-02-18T19:20:57Z

Add declaration for `#bingo:fill_registries`

bingo/data/bingo/functions/init/init.mcfunction

Lines 1111 to 1117 in d8fc361

#region run registries

data remove storage bingo:registries categories

data remove storage bingo:registries items

data remove storage bingo:registries structures

data remove storage bingo:registries hud_components

data remove storage bingo:registries preferences

function #bingo:fill_registries

Kri5t0fK · 2022-02-18T19:26:58Z

Explain registration of own items (or delete line `5` if it's to be done somewhere else)

bingo/data/bingo/functions/init/fill_registries.mcfunction

Lines 1 to 5 in d8fc361

#> bingo:init/fill_registries

#

# Registers everything in vanilla bingo.

#

# To register your own ite

- misspellings - missing letters - improved some descriptions NeunEinser#5

NeunEinser · 2022-02-19T10:22:32Z

Add declaration for #bingo:fill_registries

bingo/data/bingo/functions/init/init.mcfunction

Lines 1111 to 1117 in d8fc361

#region run registries

data remove storage bingo:registries categories

data remove storage bingo:registries items

data remove storage bingo:registries structures

data remove storage bingo:registries hud_components

data remove storage bingo:registries preferences

function #bingo:fill_registries

Only tags that are not otherwise declared (through a file) are declared with #declare. Unfortunately DPH+/SPYglass/IMP does currently not support documentation for tags like that.
See Arcensoth/imp-spec#1

NeunEinser · 2022-02-19T10:41:04Z

Is #bingo:post_register_items the same thing as #bingo:post_registration?

storage bingo:items categories[].items - mentions #bingo:post_register_items

bingo/data/bingo/functions/init/init.mcfunction

Lines 54 to 56 in d8fc361

# items: (Compund List) (readonly) List of all items this category has. Entries

# have the same structure as in the items array. Will be created

# automatically, after #bingo:post_register_items ran.

storage bingo:registries - mentions both:

bingo/data/bingo/functions/init/init.mcfunction

Lines 67 to 69 in d8fc361

# To execute an action before the registries are processed but after all active

# extension packs have registered everything, add a function to the function tag

# #bingo:post_registration

bingo/data/bingo/functions/init/init.mcfunction

Lines 82 to 84 in d8fc361

# In order to modify existing items, either added by the default bingo datapack,

# or added by another extension pack, please use a function registered to the

# function tag #bingo:post_register_items

no declaration for #bingo:post_register_items

#bingo:post_registration declaration:

bingo/data/bingo/functions/init/init.mcfunction

Lines 1119 to 1128 in d8fc361

#>

# Function tag for doing actions after the item registration, but before the

# items are duplicated into the categories array.

#

# You may use this function tag for modifing existing items from the default

# bingo item pool or from other extensio packs.

#

# @api

#declare tag/function bingo:post_registration

function #bingo:post_registration

I think #bingo:post_register_items is the old name when nothing else but items were registered.

NeunEinser · 2023-03-19T19:45:45Z

I think it's good enough now. No need to keep track of this issue anymore.

NeunEinser added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 28, 2021

NeunEinser added a commit that referenced this issue Mar 2, 2021

tick: Document and move related functions to sub-folder

ada088d

This documents the tick and set_player_id function (work towards #5). Both functions are moved to the tick subfolder now.

NeunEinser added a commit that referenced this issue Mar 2, 2021

util: Document functions and minor improvements

3af131c

This adds documentation to all util ffunctions. Work towards #5 Additionally, some names in match_uuid changed.

NeunEinser added a commit that referenced this issue Mar 2, 2021

Preferences: Add Documentation

10feda5

Adds documentation to prefrences. Work towards #5

NeunEinser added a commit that referenced this issue Mar 4, 2021

Lobby: Document set signs

72741a1

This documents the function responsible for setting signs in the lobby. Work towards #5

gbegerow mentioned this issue Jun 20, 2021

Players cannot unlock items in slots they unlocked in a previous game when they are not logged in when generating a new card #56

Closed

Kri5t0fK added a commit to Kri5t0fK/bingo that referenced this issue Feb 18, 2022

[misspell] Missing letters; Description improvements

9818616

- misspellings - missing letters - improved some descriptions NeunEinser#5

NeunEinser closed this as completed Mar 19, 2023

bl4ckscor3 mentioned this issue Aug 6, 2023

Lockout mode does not properly keep track of collected items #183

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Be better at documenting #5

Be better at documenting #5

NeunEinser commented Jan 28, 2021

Kri5t0fK commented Feb 13, 2022 •

edited

Loading

Kri5t0fK commented Feb 17, 2022

Kri5t0fK commented Feb 17, 2022

Kri5t0fK commented Feb 18, 2022

Kri5t0fK commented Feb 18, 2022

Kri5t0fK commented Feb 18, 2022

Kri5t0fK commented Feb 18, 2022

NeunEinser commented Feb 19, 2022 •

edited

Loading

Add declaration for `#bingo:fill_registries`

NeunEinser commented Feb 19, 2022 •

edited

Loading

Is `#bingo:post_register_items` the same thing as `#bingo:post_registration`?

NeunEinser commented Mar 19, 2023

Be better at documenting #5

Be better at documenting #5

Comments

NeunEinser commented Jan 28, 2021

Kri5t0fK commented Feb 13, 2022 • edited Loading

Kri5t0fK commented Feb 17, 2022

Is #bingo:post_register_items the same thing as #bingo:post_registration?

Kri5t0fK commented Feb 17, 2022

Maybe add info that bingo:items are generated from bingo:registries?

Kri5t0fK commented Feb 18, 2022

Add more info about strict mode (description, only used in MP)

Kri5t0fK commented Feb 18, 2022

Kri5t0fK commented Feb 18, 2022

Kri5t0fK commented Feb 18, 2022

Explain registration of own items (or delete line 5 if it's to be done somewhere else) bingo/data/bingo/functions/init/fill_registries.mcfunction Lines 1 to 5 in d8fc361 #> bingo:init/fill_registries # # Registers everything in vanilla bingo. # # To register your own ite

NeunEinser commented Feb 19, 2022 • edited Loading

Add declaration for #bingo:fill_registries

NeunEinser commented Feb 19, 2022 • edited Loading

Is #bingo:post_register_items the same thing as #bingo:post_registration?

NeunEinser commented Mar 19, 2023

Kri5t0fK commented Feb 13, 2022 •

edited

Loading

Is `#bingo:post_register_items` the same thing as `#bingo:post_registration`?

Maybe add info that `bingo:items` are generated from `bingo:registries`?

Add more info about `strict mode` (description, only used in MP)

Explain registration of own items (or delete line `5` if it's to be done somewhere else)

bingo/data/bingo/functions/init/fill_registries.mcfunction

Lines 1 to 5 in d8fc361

#> bingo:init/fill_registries

#

# Registers everything in vanilla bingo.

#

# To register your own ite

NeunEinser commented Feb 19, 2022 •

edited

Loading

Add declaration for `#bingo:fill_registries`

NeunEinser commented Feb 19, 2022 •

edited

Loading

Is `#bingo:post_register_items` the same thing as `#bingo:post_registration`?