feat: add doFullSerialization support to blocks #7363
Conversation
32a57f3
to
b644721
Compare
core/block.ts
Outdated
| * | ||
| * @param doFullSerialization Whether or not to serialize the full state of | ||
| * the extra state (rather than possibly saving a reference to some | ||
| * state). This is used during copy-paste. |
There was a problem hiding this comment.
nit: could you say which way this should be used in copy-paste? e.g. "This should be true when pasting a block." Actually it might be helpful to have more documentation on this parameter because I'm not sure how this is meant to be used. If I am creating custom blocks, I need more information on what is "full" serialization and what isn't. Maybe you can add more documentation to devsite and then link to it here.
There was a problem hiding this comment.
Added links under blocks and fields. Can't add links under icons because the base icon class doesn't implement serialization - subclasses need to implement the ISerializable interface.
The links will be dead until the next release + release of the documentation.
The basics
npm run formatandnpm run lintThe details
Resolves
Fixes #7339
Proposed Changes
Passes a
doFullSerializationparameter to blocks'saveExtraStatemethods.Reason for Changes
This parameter signals that they should serialize all of their state (instead of just serializing a reference to it) for use during copy-paste.
Test Coverage
N/A
Documentation
N/A
Additional Information
Dependent on #7356