Minecraftforge: Typos

Created on 24 Dec 2017  路  18Comments  路  Source: MinecraftForge/MinecraftForge

Use this issue to list all typos in documentation and anywhere else in the codebase.
I can fix them when there are a lot listed here.

All 18 comments

3533

Not exactly typos, but inconsistencies and misnamings that might be nice to fix:

  • Material#setBurning() is misnamed because it sets the canBurn field. So grammatically it doesn't set it to actually burning but rather setCanBurn() to be consistent.
  • Block#silk_check_state field uses snake case instead of camel case
  • EntityLivingBase#_combatTracker has a preceding underscore for some reason (I know some coding standards do this for non-final static fields, but this is final field...)
  • EntityLivingBase#getIsInvulnerable() should really be just isInvulnerable() to match other "is" boolean getters in the Entity type classes.

@jabelar Naming of vanilla methods/classes/fields is done by the MCP mappings. Issues with names of vanilla methods/classes/fields should go on the MCP issue repo.

There are probably some in here
https://github.com/MinecraftForge/MinecraftForge/pull/3518
as this has been the post people refer to to tell people that single, typo fixing changes will generally not be accepted

3287

The readme file contains the wrong main branch. It should be 1.12.x and not 1.10.x.

@SirWindfield Same as #3533.

Adding this to the list as well since I'll be editing the readme: https://github.com/MinecraftForge/MinecraftForge/issues/2260

https://github.com/MinecraftForge/MinecraftForge/blob/cfbcfeaf4b5d55d5fd1af70b84139ff0d205a9b8/src/main/java/net/minecraftforge/common/property/ExtendedBlockState.java#L101
Can use the predicate to check isEmpty instead of checking equality

Edit: More exactly, change this line to

if (unlistedProperties.values().stream().noneMatch(Optional::isPresent))

not exactly a typo but the documentation for the pre-init event still talks about registering things there with the gameregistry, this should probably be updated to mention the new registry events instead

I doubt you are going to fix typo's in MC code, but ill post it anyway:

WorldSever.tickUpdates line 726 throw new IllegalStateException("TickNextTick list out of synch");

Will link this draft of an update to the readme I made:
https://gist.github.com/bs2609/0ff0b4f31c86cfb2325260dd95748f79

Fixing vanilla typos is out of scope for this issue, yeah.

Also might be nice to clean up the example mod in the MDK a bit, to show better practices.
Something like this: https://gist.github.com/bs2609/0f31067433ea9a9481e0339b01ad75fc

If the example mod would be updated, it might be a good idea to include comments in the pre-init ,init, and post-init to say what is initialized at what time.

The documentation for the pre/init/post events should have that information.

This is superseded by a PR, please move any discussion there: https://github.com/MinecraftForge/MinecraftForge/pull/4664

Was this page helpful?
0 / 5 - 0 ratings