Make (most of) the examples executable again #695
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also make some changes to simplify future code checks.
ST-DDT
added
needs review
ST-DDT
commented
May 27, 2018
source/plugin/scheduler.rst
Outdated
| | | | could look like "fooplugin-A-12". No two active tasks will have the same | | | ||
| | | | serial ID for the same synchronization type. If a task name is specified, | | | ||
| | | | it should be descriptive and aid users in debugging your plugin. | | | ||
| +-----------------+-------------------------+---------------------------------------------------------------------------+----------------------------------------------------+ |
ST-DDT
commented
May 27, 2018
source/plugin/wgen/customwgen.rst
Outdated
| buffer.setBiome(x, y, BiomeTypes.FOREST); | ||
| } else if (x * x + y * y < BEACH_RADIUS) { | ||
| buffer.setBiome(x, y, BiomeTypes.BEACH); | ||
| for (int z = min.getY(); z <= max.getY(); z++) { |
ST-DDT
force-pushed
the
fixes/code-compileable
branch
from
838c3da to
d3fda5d
Compare
|
There are some "cosmetic" changes such as
|
parlough
approved these changes
May 27, 2018
gabizou
requested changes
May 29, 2018
| @@ -214,7 +214,7 @@ There add a line to register (and create) your used keys. | |||
|
|
|||
| .. code-block:: java | |||
|
|
|||
| keyMap.put("health"), makeSingleKey(Double.class, MutableBoundedValue.class, of("Health"))); | |||
| keyMap.put("health", makeSingleKey(Double.class, MutableBoundedValue.class, of("Health"))); | |||
There was a problem hiding this comment.
All the key stuff needs to be updated to use the register method like so:
this.register(Key.builder().type(TypeTokens.BOUNDED_DOUBLE_VALUE_TOKEN).id("health").name("Health").query(of("Health")).build())
source/plugin/assets.rst
Outdated
| @@ -50,7 +50,10 @@ following code: | |||
| import java.nio.file.Files; | |||
|
|
|||
| if (Files.notExists(configPath)) { | |||
| plugin.getAsset("default.conf").copyToFile(configPath); | |||
| Optional<Asset> asset = plugin.getAsset("default.conf"); | |||
| if (asset.isPresent()) { | |||
There was a problem hiding this comment.
Can simplify this to
plugin.getAsset("default.conf").ifPresent(asset -> asset.copyToDirectory(configPath));
source/plugin/entities/spawning.rst
Outdated
| @@ -35,8 +32,7 @@ For example, let's try to spawn a Creeper: | |||
| World world = spawnLocation.getExtent(); | |||
| Entity creeper = world | |||
| .createEntity(EntityTypes.CREEPER, spawnLocation.getPosition()); | |||
| SpawnCause spawnCause = SpawnCause.builder().type(SpawnTypes.PLUGIN).build(); | |||
| world.spawnEntity(creeper, Cause.source(spawnCause).build()); | |||
| world.spawnEntity(creeper); | |||
There was a problem hiding this comment.
Should be pushing to the cause stack frame for a SpawnType.
source/plugin/items/creating.rst
Outdated
| } | ||
| Entity item = extent.createEntity(EntityTypes.ITEM, spawnLocation.getPosition()); | ||
| item.offer(Keys.REPRESENTED_ITEM, superMegaAwesomeSword.createSnapshot()); | ||
| extent.spawnEntity(item); |
There was a problem hiding this comment.
Likewise here, need to add the SpawnType to the context.
There was a problem hiding this comment.
Can wrap with:
try (CauseStackManager.StackFrame frame = Sponge.getCauseStackManager().pushStackFrame()) {
frame.addContext(EventContextKeys.SPAWN_TYPE, SpawnTypes.PLACEMENT);
extent.spawnEntity(item);
}
ST-DDT
force-pushed
the
fixes/code-compileable
branch
from
8c4b8b6 to
85d0aee
Compare
ST-DDT
force-pushed
the
fixes/code-compileable
branch
from
fa82eaa to
5df4f63
Compare
Inscrutable
removed
the
needs review
|
@gabizou I fixed the issues you pointed out in your comments. Is everything now correct? |
parlough
approved these changes
Jun 16, 2018
gabizou
approved these changes
Jun 17, 2018
|
|
||
| public SpongeHealthData() { | ||
| this(DataConstants.DEFAULT_HEALTH, DataConstants.DEFAULT_HEALTH); | ||
| this(DEFAULT_HEALTH, DEFAULT_HEALTH); |
There was a problem hiding this comment.
I'd rather have this not static imported, only because static imports are somewhat evil ambiguous as to where they (the constants) come from.
source/plugin/entities/spawning.rst
Outdated
|
|
||
| Entity creeper = world.createEntity(EntityTypes.CREEPER, spawnLocation.getPosition()); | ||
|
|
||
| try (StackFrame frame = Sponge.getCauseStackManager().pushCauseFrame()) { |
There was a problem hiding this comment.
Not sure if the cause stack manager is documented, but may want to add a code comment that the context needs to be wrapped in the frame because of the changes.
Likewise, mention that the plugin's PluginContainer is already pushed to the cause stack.
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As mentioned in #437 (comment) I went through all code examples and tried to make sure that they actually compile with API version 7.
I also make some changes to simplify future code checks.
I couldn't verify some parts such as whether the method signature is still correct if only a method is contained in that code example. There are currently 292 Java Code Blocks in there.
Fixes #571.