Skip to content

Mapping Conventions

ChampionAsh5357 edited this page Jul 4, 2021 · 3 revisions

The mapping conventions are the set of names and stipulations that are generally agreed upon by reviewers and the mapping standards team, to ensure consistency in naming and documenting by contributors. These conventions are not set in stone, and may be changed by the mapping standards team to reflect consensus of the reviewers or the standards team.

Contributors are directed to follow these conventions when mapping and documenting, to create consistency across all classes and packages. Contributons may deviate from these conventions when needed, such as to add more specific detail or context or to avoid ambiguity.

For any errors, corrections, or additions to these conventions, please contact the mapping standards team.

Parameter Names Conventions

  • Parameter names which are assigned directly to fields should be named the same as the field.
  • Copy constructors, equals methods, and compareTo methods should have their single parameter named as other.

Table of Abbreviations

Class Name Abbreviation(s)
net.minecraft.core.BlockPos pos
net.minecraft.world.level.block.state.BlockState state
com.mojang.serialization.DynamicOps ops