Add comprehensive reference examples for all Sprite public methods #11
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 implements a complete set of reference examples for all public methods in the
Spriteclass, following the existing pattern established byAnimatedSpriteAddAnimation.Problem
The
src/examples/java/referencedirectory was missing examples for many Sprite public methods. While some methods likeSpriteAddCostume,SpriteMove, andSpriteSayhad examples, dozens of other public methods lacked demonstration code, making it harder for users to understand how to use the full API.Solution
Added 45 new examples covering all previously missing Sprite public methods:
Examples Added
SpriteGoToRandomPosition,SpriteGoToMousePointer,SpriteGoToSprite,SpritePointInDirection,SpritePointTowardsSpriteSpriteSetWidth,SpriteSetHeight,SpriteChangeSize,SpriteGetSize,SpriteGetTint,SpriteGetTransparencySpriteChangePosition,SpriteGetPosition,SpriteGetMouseX,SpriteGetMouseYSpriteAddCostumes(spritesheet support),SpritePreviousCostume,SpriteSetNineSlice,SpriteDisableNineSliceSpriteGetTouchingSprite,SpriteGetTouchingSprites,SpriteGetHitbox,SpriteDisableHitbox,SpriteEnableHitboxSpriteStopSound,SpriteIsSoundPlayingSpriteStampToBackground,SpriteStampToUI,SpriteStampToForegroundSpriteGetCurrentYear,SpriteGetCurrentMonth,SpriteGetCurrentDay,SpriteGetCurrentHour,SpriteGetCurrentMinute,SpriteGetCurrentSecond,SpriteGetDaysSince2000SpriteClone,SpriteRemove,SpriteGetStage,SpriteGetWindow,SpriteGetText,SpriteIsUI,SpriteRemoveTimerSpriteSetRun,SpriteSetWhenIReceive,SpriteSetWhenMouseClicked(package-based examples)Implementation Details
GifRecorderfor visual outputSpriteMethodName.java)SpriteMethodName/MySprite.java,MyStage.java,MyWindow.java)zeta_green_badge.png,gamma_purple_badge.png, andbump.wavExample Usage
This provides complete API coverage, making it easier for developers to learn and use all Sprite functionality available in Scratch for Java.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
jogamp.org/usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.11/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.11/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.11 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.11/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/scratch-for-java/scratch-for-java org.codehaus.plexus.classworlds.launcher.Launcher compile -q(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.