Wipe parsing #1053
Open
Wipe parsing #1053
Conversation
This file contains hidden or 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
maddie480-bot
added
the
review needed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
this PR adds some alternative ways for modders to apply their Screen Wipes to a map.
this mainly serves to give unique identifiers to the Screen Wipes, so that the game doesn't have to check for their full type names, and their classes can be freely reorganised if needed.
Everest.Events.MapMeta.OnParseWipeaccepts a method that returns anAction<Scene, bool, Action>and takes the argumentstring wipe, which is the value of the current Wipe metadata being parsed.the parameters of the returned
Actionare similar to the constructor for a Screen Wipe:(Scene scene, bool wipeIn, Action onComplete).the
[CustomWipe]attribute should be placed on a class that extendsScreenWipe, and is used to give it a unique identifier. the class requires one of the following in order to be registered as a custom wipe:public staticgenerator method (calledLoadby default) that returnsScreenWipeand has the signature(Scene scene, bool wipeIn, Action onComplete), or...(Scene scene, bool wipeIn, Action onComplete).