Documentation
¶
Index ¶
- Constants
- Variables
- func AddScore(p Peer, b Board, v int16) int16
- func ClearScreen(c Color)
- func DrawArc(p Point, d int, start, sweep Angle, s Style)
- func DrawCircle(p Point, d int, s Style)
- func DrawEllipse(p Point, b Size, s Style)
- func DrawImage(i Image, p Point)
- func DrawLine(a, b Point, s LineStyle)
- func DrawPoint(p Point, c Color)
- func DrawQR(t string, p Point, black, white Color)
- func DrawQRBytes(t []byte, p Point, black, white Color)
- func DrawRect(p Point, b Size, s Style)
- func DrawRoundedRect(p Point, b, c Size, s Style)
- func DrawSector(p Point, d int, start, sweep Angle, s Style)
- func DrawSubImage(i SubImage, p Point)
- func DrawText(t string, f Font, p Point, c Color)
- func DrawTextBytes(t []byte, f Font, p Point, c Color)
- func DrawTriangle(a, b, c Point, s Style)
- func DumpFile(path string, raw []byte)
- func FileExists(path string) bool
- func GetFileSize(path string) int
- func GetName(p Peer) string
- func GetRandom() uint32
- func GetScore(p Peer, b Board) int16
- func LogDebug(t string)
- func LogDebugBytes(t []byte)
- func LogError(t string)
- func LogErrorBytes(t []byte)
- func Quit()
- func RemoveFile(path string)
- func Restart()
- func SaveStash(p Peer, b Stash)
- func SetCanvas(c Canvas)
- func SetColor(c Color, v RGB)
- func SetPalette(colors [16]RGB)
- func SetSeed(seed uint32)
- func UnsetCanvas()
- type Angle
- type AnyPeer
- type Atlas
- type Badge
- type Board
- type Buttons
- type Canvas
- type Color
- type DPad4
- type DPad8
- type File
- type Font
- type Image
- func (i Image) Draw(p Point)
- func (i Image) GetPixel(point Point) Color
- func (i Image) Height() int
- func (i Image) Pixels() int
- func (i Image) SetTransparency(c Color)
- func (i Image) Size() Size
- func (i Image) Sub(p Point, s Size) SubImage
- func (i Image) Transparency() Color
- func (i Image) Width() int
- type Language
- type LineStyle
- type Me
- type Pad
- type Peer
- type Peers
- type Point
- type Progress
- type RGB
- type Settings
- type Size
- type Sprite
- type Stash
- type Style
- type SubImage
- type Theme
Constants ¶
const ( // The screen width in pixels. Width = 240 // The screen height in pixels. Height = 160 )
const ( // The lowest possible value for [Pad.X]. PadMinX = -1000 // The lowest possible value for [Pad.Y]. PadMinY = -1000 // The highest possible value for [Pad.X]. PadMaxX = 1000 // The highest possible value for [Pad.Y]. PadMaxY = 1000 )
Variables ¶
var ( // Callback to be called once when the app starts. // // Called after memory is initialized and host functions are registered // but before any other callback. Boot func() // Callback to be called on every update. // // Don't use it to draw on the screen, use [Render] instead. Update func() // Callback to be called before rendering the frame. // // Don't use it to update the state, use [Update] instead. Render func() // Callback to be called before exiting the app. BeforeExit func() // Callback to be called when a cheat code is sent from firefly CLI. // // Accepts the command index and value and returns a response to show in CLI. Cheat func(int, int) int )
var Combined = Peer{0xFF}
A combination of all connected peers.
Can be passed in functions like ReadPad and ReadButtons to get the combined input of all peers.
Useful for single-player games that want in multiplayer to handle inputs from all devices as one input.
Functions ¶
func AddScore ¶ added in v0.7.0
Add the given score to the board.
May be negative if you want the lower scores to rank higher. Zero value is not added to the board.
If the Peer is Combined, the score is added for every peer and the returned value is the lowest of their best scores.
func DrawQRBytes ¶ added in v0.11.0
Render a QR code for the given text byte slice.
Input slice must be valid UTF-8 formatted (without BOM).
Useful when you are building strings in a byte array or slice, such as via a bytes.Buffer. This function allows you to use such content without allocating a new string.
It is allowed to modify the byte slice after the function call.
func DrawRoundedRect ¶
Draw a rectangle with rounded corners.
func DrawSubImage ¶
Draw a subregion of an image.
Most often used to draw a sprite from a sprite atlas.
func DrawText ¶
Render text using the given font.
Unlike in the other drawing functions, here Point points not to the top-left corner but to the baseline start position.
func DrawTextBytes ¶ added in v0.11.0
Render text using the given font.
Unlike in the other drawing functions, here Point points not to the top-left corner but to the baseline start position.
Input slice must be valid UTF-8 formatted (without BOM).
Useful when you are building strings in a byte array or slice, such as via a bytes.Buffer. This function allows you to use such content without allocating a new string.
It is allowed to modify the byte slice after the function call.
func GetFileSize ¶ added in v0.9.5
Get size (in bytes) of the given file.
func LogDebugBytes ¶ added in v0.11.0
func LogDebugBytes(t []byte)
Log a debug message from byte slice.
Input slice must be valid UTF-8 formatted (without BOM).
Useful when you are building strings in a byte array or slice, such as via a bytes.Buffer. This function allows you to use such content without allocating a new string.
It is allowed to modify the byte slice after the function call.
func LogErrorBytes ¶ added in v0.11.0
func LogErrorBytes(t []byte)
Log an error message from byte slice.
Input slice must be valid UTF-8 formatted (without BOM).
Useful when you are building strings in a byte array or slice, such as via a bytes.Buffer. This function allows you to use such content without allocating a new string.
It is allowed to modify the byte slice after the function call.
func SaveStash ¶ added in v0.8.0
Save the given Stash.
When called, the stash for the given peer will be stored in RAM. Calling LoadStash for the same peer will return that stash. On exit, the runtime will persist the stash in FS. Next time the app starts, calling LoadStash will restore the stash saved earlier.
func SetCanvas ¶ added in v0.6.0
func SetCanvas(c Canvas)
Set the target image for all subsequent drawing operations.
func SetPalette ¶ added in v0.9.4
func SetPalette(colors [16]RGB)
Set all colors in the color palette.
func UnsetCanvas ¶ added in v0.6.0
func UnsetCanvas()
Make all subsequent drawing operations target the screen instead of a canvas.
Cancels the effect of SetCanvas.
Types ¶
type Angle ¶
type Angle struct {
// contains filtered or unexported fields
}
An angle between two vectors.
Used by DrawArc and DrawSector. Constructed by [Dagrees] and Radians.
type AnyPeer ¶ added in v0.12.0
type AnyPeer interface {
// contains filtered or unexported methods
}
type Atlas ¶ added in v0.11.0
type Atlas struct {
// contains filtered or unexported fields
}
Helper for working with spritesheets.
Constructed by NewAtlas.
func (*Atlas) Load ¶ added in v0.11.0
Set the underlying spritesheet image for the atlas.
Should be called before any Sprite.Draw. The best is to call it once from Boot.
type Buttons ¶
type Buttons struct {
// South. The bottom button, like A on the X-Box controller.
//
// Typically used for confirmation, main action, jump, etc.
S bool
// East. The right button, like B on the X-Box controller.
//
// Typically used for cancellation, going to previous screen, etc.
E bool
// West. The left button, like X on the X-Box controller.
//
// Typically used for attack.
W bool
// North. The top button, like Y on the X-Box controller.
//
// Typically used for a secondary action, like charged attack.
N bool
// The menu button, almost always handled by the runtime.
Menu bool
}
State of the buttons.
func ReadButtons ¶
Get the currently pressed buttons.
func (Buttons) JustPressed ¶
Given the old state, get buttons that were not pressed but are pressed now.
func (Buttons) JustReleased ¶
Given the old state, get buttons that were pressed but aren't pressed now.
type Canvas ¶ added in v0.6.0
type Canvas struct {
// contains filtered or unexported fields
}
Canvas is an Image that can be drawn upon.
Constructed by NewCanvas.
type Color ¶
type Color uint8
A pointer to a color in the color palette.
const ( // No color (100% transparency). Default. ColorNone Color = 0 // Black color: #1A1C2C. ColorBlack Color = 1 // Purple color: #5D275D. ColorPurple Color = 2 // Red color: #B13E53. ColorRed Color = 3 // Orange color: #EF7D57. ColorOrange Color = 4 // Yellow color: #FFCD75. ColorYellow Color = 5 // Light green color: #A7F070. ColorLightGreen Color = 6 // Green color: #38B764. ColorGreen Color = 7 // Dark green color: #257179. ColorDarkGreen Color = 8 // Dark blue color: #29366F. ColorDarkBlue Color = 9 // Blue color: #3B5DC9. ColorBlue Color = 10 // Light blue color: #41A6F6. ColorLightBlue Color = 11 // Cyan color: #73EFF7. ColorCyan Color = 12 // White color: #F4F4F4. ColorWhite Color = 13 // Light gray color: #94B0C2. ColorLightGray Color = 14 // Gray color: #566C86. ColorGray Color = 15 // Dark gray color: #333C57. ColorDarkGray Color = 16 )
func (Color) String ¶ added in v0.11.0
Get the color name in the default palette (SWEETIE-16).
Implements fmt.Stringer.
type DPad4 ¶ added in v0.10.0
type DPad4 uint8
4-directional DPad-like representation of the Pad.
Constructed with Pad.DPad4. Useful for simple games and ports. The middle of the pad is a "dead zone" pressing which will not activate any direction.
Implements all the same methods as DPad8.
const ( DPad4None DPad4 = 0 DPad4Right DPad4 = 1 DPad4Up DPad4 = 2 DPad4Left DPad4 = 3 DPad4Down DPad4 = 4 )
Possible directions for DPad4.
func (DPad4) JustPressed ¶ added in v0.10.0
func (DPad4) JustReleased ¶ added in v0.10.0
type DPad8 ¶ added in v0.10.0
8-directional DPad-like representation of the Pad.
Constructed with Pad.DPad8. Useful for simple games and ports. The middle of the pad is a "dead zone" pressing which will not activate any direction.
Invariant: it's not possible for opposite directions (left and right, or down and up) to be active at the same time. However, it's possible for neighboring directions (like up and right) to be active at the same time if the player presses a diagonal.
Implements all the same methods as DPad4.
func (DPad8) Held ¶ added in v0.10.0
Given the old state, get directions that were pressed and are still pressed now.
func (DPad8) JustPressed ¶ added in v0.10.0
Given the old state, get directions that were not pressed but are pressed now.
func (DPad8) JustReleased ¶ added in v0.10.0
Given the old state, get directions that were pressed but aren't pressed now.
type File ¶
type File []byte
A file loaded from the filesystem.
func LoadFile ¶ added in v0.6.0
Read a file.
It will first lookup file in the app's ROM directory and then check the app writable data directory.
If the file does not exist, the Raw value of the returned File will be nil.
The second argument is the buffer in which the file should be loaded. If the buffer is smaller than the file content, it gets cut. If the buffer is nil, a new buffer of sufficient size will be allocated.
type Font ¶
type Font struct {
// contains filtered or unexported fields
}
A loaded font file.
Can be loaded using LoadFile.
func (Font) DrawBytes ¶ added in v0.11.0
Render the given text bytes.
Input slice must be valid UTF-8 formatted (without BOM).
Useful when you are building strings in a byte array or slice, such as via a bytes.Buffer. This function allows you to use such content without allocating a new string.
It is allowed to modify the byte slice after the function call.
type Image ¶
type Image struct {
// contains filtered or unexported fields
}
A loaded image file.
Can be loaded using LoadFile.
func (Image) GetPixel ¶ added in v0.11.0
Get color of a pixel in the image.
Returns ColorNone if out of bounds.
func (Image) SetTransparency ¶ added in v0.6.0
Set the color that should represent transparency.
Pass ColorNone to disable transparency.
func (Image) Transparency ¶ added in v0.6.0
The color used for transparency. If no transparency, returns ColorNone.
type Language ¶ added in v0.11.0
type Language uint16
const ( English Language = 0x656e // en 🇬🇧 💂 Dutch Language = 0x6e6c // nl 🇳🇱 🧀 French Language = 0x6672 // fr 🇫🇷 🥐 German Language = 0x6465 // de 🇩🇪 🥨 Italian Language = 0x6974 // it 🇮🇹 🍕 Polish Language = 0x706c // pl 🇵🇱 🥟 Romanian Language = 0x726f // ro 🇷🇴 🧛 Russian Language = 0x7275 // ru 🇷🇺 🪆 Spanish Language = 0x6573 // es 🇪🇸 🐂 Swedish Language = 0x7376 // sv 🇸🇪 ❄️ Turkish Language = 0x7472 // tr 🇹🇷 🕌 Ukrainian Language = 0x756b // uk 🇺🇦 ✊ TokiPona Language = 0x7470 // tp 🇨🇦 🙂 )
func (Language) NameEnglish ¶ added in v0.11.0
func (Language) NameNative ¶ added in v0.11.0
type Me ¶ added in v0.12.0
type Me struct {
// contains filtered or unexported fields
}
The peer representing the current device.
Can be compared to Peer (using Me.Eq) or used to GetSettings.
**IMPORTANT:** Using this type may cause state drift between device in multiplayer. See the docs for more info.
type Pad ¶
A finger position on the touch pad.
Both X and Y are somewhere the range between -1000 and 1000 (both ends included). The 1000 X is on the right, the 1000 Y is on the top.
func (Pad) Azimuth ¶
The angle of the polar coordinate of the touch point.
func (Pad) RadiusSquared ¶ added in v0.11.0
Radius returns the squared distance from the pad center to the touch point, which is simpler to calculate, and guarantees that the return value is an integer.
type Peer ¶ added in v0.3.0
type Peer struct {
// contains filtered or unexported fields
}
The peer ID.
Can be obtained by getting the list of Peers using GetPeers and then iterating over it.
type Peers ¶ added in v0.3.0
type Peers uint32
The list of peers online.
Can be obtained using GetPeers.
func GetPeers ¶ added in v0.3.0
func GetPeers() Peers
Get the list of peers that are currently online.
Includes the local device.
It can be used to detect if multiplayer is active: if there is more than 1 peer, you're playing with friends.
type Point ¶
A point on the screen.
Typically, the upper-left corner of a bounding box of a shape.
func (Point) ComponentMax ¶
Set both X and Y to their maximum in the two given points.
func (Point) ComponentMin ¶
Set both X and Y to their minimum in the two given points.
type Progress ¶ added in v0.7.0
type Progress struct {
// How many points the player already has.
Done uint16
// How many points the player needs to earn the badge.
Goal uint16
}
func AddProgress ¶ added in v0.7.0
Add the given value to the progress for the badge.
May be negative if you want to decrease the progress. If zero, does not change the progress.
If the Peer is Combined, the progress is added to every peer and the returned value is the lowest progress.
func GetProgress ¶ added in v0.7.0
Get the progress of earning the badge.
type Settings ¶ added in v0.11.0
type Settings struct {
// The preferred color scheme of the player.
Theme Theme
// The configured interface language.
Language Language
// If true, the screen is rotated 180 degrees.
//
// In other words, the player holds the device upside-down.
// The touchpad is now on the right and the buttons are on the left.
RotateScreen bool
// The player has photosensitivity. The app should avoid any rapid flashes.
ReduceFlashing bool
// The player wants increased contrast for colors.
//
// If set, the black and white colors in the default
// palette are adjusted automatically. All other colors
// in the default palette or all colors in a custom palette
// should be adjusted by the app.
Contrast bool
// If true, the player wants to see easter eggs, holiday effects, and weird jokes.
EasterEggs bool
}
type Size ¶
type Size struct {
// W is the width of the bounding box.
W int
// H is the height of the bounding box.
H int
}
Size of a bounding box for a shape.
The width and height must be positive.
func (Size) ComponentMax ¶
Set both W and H to their maximum in the two given sizes.
func (Size) ComponentMin ¶
Set both W and H to their minimum in the two given sizes.
type Sprite ¶ added in v0.11.0
type Sprite struct {
// contains filtered or unexported fields
}
func (Sprite) Draw ¶ added in v0.11.0
Render the sprite at the given position.
Make sure to call Atlas.Load first.
type Stash ¶ added in v0.8.0
type Stash = []byte
Stash is a serialized binary state of the app that you want to persist between app runs and to be available in multiplayer.
For single-player purposes, you can save data in a regular file using DumpFile. File saved that way can be bigger (and you can create lots of them) but it cannot be accessed in multiplayer.
It's your job to serialize data into a binary stash and later parse it. Stash can be saved using SaveStash and later read using LoadStash.
func LoadStash ¶ added in v0.8.0
Load Stash saved earlier (in this or previous run) by SaveStash.
The buffer should be big enough to fit the stash. If it's not, the stash will be truncated. If there is no stash or it's empty, nil is returned.
If the given buffer is nil, a new buffer will be allocated big enough to fit the biggest allowed stash. At the moment, it is 80 bytes.
type Style ¶
type Style struct {
// The color to use to fill the shape.
FillColor Color
// The color to use for the shape stroke.
StrokeColor Color
// The width of the shape stroke.
//
// If zero, a solid shape without a stroke will be drawn.
StrokeWidth int
}
Style of a shape.
type SubImage ¶
type SubImage struct {
// contains filtered or unexported fields
}
A subregion of an image. Constructed using Image.Sub.
func (SubImage) Image ¶ added in v0.11.0
Image returns back the original parent Image from which this sub-image was created from.
func (SubImage) Point ¶ added in v0.11.0
Point returns the offset of this sub-image in the parent Image.
Source Files
Directories