diff --git a/src/main/java/mod/chiselsandbits/api/IBitAccess.java b/src/main/java/mod/chiselsandbits/api/IBitAccess.java index 6f3684d5..0e9b53ec 100644 --- a/src/main/java/mod/chiselsandbits/api/IBitAccess.java +++ b/src/main/java/mod/chiselsandbits/api/IBitAccess.java @@ -69,6 +69,12 @@ void setBitAt( * affect, optionally you can trigger updates or not. * * If the {@link IBitAccess} is not in the world this method does nothing. + * + * All changes made by a player should be committed on the client and the + * server, failure to commit changes on the client will cause corruption of + * the Undo Pipeline, causing 'Block Has Changed' errors when trying to undo + * blocks that have been modified only on the server, doing so also + * increases responsiveness in those changes for the player making them. * * @param triggerUpdates * normally true, only use false if your doing something special. diff --git a/src/main/java/mod/chiselsandbits/api/IChiselAndBitsAPI.java b/src/main/java/mod/chiselsandbits/api/IChiselAndBitsAPI.java index cf79982a..62e4dc49 100644 --- a/src/main/java/mod/chiselsandbits/api/IChiselAndBitsAPI.java +++ b/src/main/java/mod/chiselsandbits/api/IChiselAndBitsAPI.java @@ -167,8 +167,13 @@ IBitBag getBitbag( ItemStack stack ); /** - * Begins an undo operation, starting two operations without ending the - * previous operation will throw a runtime exception. + * Begins an undo group, starting two operations without ending the previous + * operation will throw a runtime exception. + * + * This is used to merge multiple blocks into a single operation, undo steps + * will be recorded regardless of usage of this method, however its + * suggested to use groups in any case where a change well affect more then + * one block. * * @formatter:off * @@ -182,9 +187,9 @@ void beginUndoGroup( EntityPlayer player ); /** - * Ends a previously running undo operation, must be called after starting - * an undo operation, closing a group without opening one will result in a - * runtime exception. + * Ends a previously running undo group, must be called after starting an + * undo group, closing a group without opening one will result in a runtime + * exception. */ void endUndoGroup( EntityPlayer player );