ProTrackR2 (version 0.1.1)

pt2_command: Extract effect commands from a ProTracker module

Description

As explained in vignette("s3class"), the ProTracker pattern table consists of cells, containing information about the note and instrument to be played. This function can be used to retrieve or replace the effect commands in a module.

Usage

pt2_command(x, ...)
pt2_command(x, silent = TRUE, ...) <- value

Value

Returns a pt2command object containing the raw command code. In case of the assign operator (<-) an update version of x is returned.

Arguments

x

An object of class pt2cell, which can be extracted from a pattern table with pt2_cell(). A cell list (class pt2celllist) is also allowed. See vignette("sel_assign") for more details about selecting cells and cell lists.

...

Ignored

silent

Don't warn about replacement values not being used or recycled.

value

A replacement value. It should be an object that can be converted into an effect command. It can be a character string as shown in the example below.

Examples

mod <- pt2_read_mod(pt2_demo())

## select a specific cell from the module
cell <- pt2_cell(mod$patterns[[1]], 0L, 0L)

## show the command used for this cell
pt2_command(cell)

## convert character strings into ProTracker commands
pt2_command(c("C30", "F06"))

## Set the command for all cells in the first pattern
## to `C20` (volume at 50%):
pt2_command(mod$patterns[[1]][]) <- "C20"