Machine

The Machine library is dedicated to functions related to power control and external features such as window title and Discord Rich Presence.

Usage

local machine = require("machine")

-- Shutdown and exit Capy64
machine.shutdown()

-- Reboot
machine.reboot()

Functions

shutdown

machine.shutdown()

Shutdown and exit Capy64.

reboot

machine.reboot()

Reboot the runtime.

title

machine.title( [ newTitle ] )

Get and set the window title. An empty string resets the title to "Capy64 " + Version.

Titles are limited to 256 characters.

Parameters

1. newTitle : string? - New title to set.

Returns

1. title : string - Title before the change.

getClipboard

machine.getClipboard()

Get the contents of the user's clipboard.

Returns

1. contents : string - Clipboard contents.

setClipboard

machine.setClipboard( newContents )

Set the contents of the user's clipboard.

Parameters

1. newContents : string - Contents to be pushed to the clipboard.

version

machine.version()

Get the current version of Capy64.

Returns

1. version : string - Current version.

setRPC

machine.setRPC( details, [ state ])

Set the Discord RPC texts if enabled.

Parameters

1. details : string - Top line.
2. state : string? - Bottom line.

vibrate

machine.vibrate( leftStrength, [ rightStrength ] )

Vibrates the connected gamepad with given left and right strengths.
Left is low frequency, so it may feel stronger than right.
rightStrength defaults to leftStrength if one is not given.

This only works if at least one gamepad is connected. If multiple are connected, it vibrates the primary gamepad.

Parameters

1. leftStrength : number - Left vibration strength. (Low frequency.)
2. rightStrength : number? - Right vibration strength. (High frequency.)

---

Last update: March 11, 2023
Created: March 11, 2023