write.AmigaIcon: Write an Amiga Workbench icon (info) file

View source: R/workbench_icon.r

write.AmigaIconR Documentation

Write an Amiga Workbench icon (info) file

Description

Graphical representation of files and directories (icons) are stored as separate files (with the .info extension) on the Amiga. This function writes AmigaIcon class objects to such files.

Usage

write.AmigaIcon(x, file, disk = NULL)

Arguments

x

An AmigaIcon class object.

file

A character string representing the file name to which the icon data should be written.

disk

A virtual Commodore Amiga disk to which the file should be written. This should be an amigaDisk object. Using this argument requires the adfExplorer package. When set to NULL, this argument is ignored.

Details

The AmigaIcon S3 object provides a comprehensive format for Amiga icons, which are used as a graphical representation of files and directories on the Amiga. The AmigaIcon is a named list containing all information of an icon. Use this function to write this object to a file which can be used on the Commodore Amiga or emulator.

Value

Returns NULL or an integer status passed on by the close function, that is used to close the file connection. It is returned invisibly. Or, when disk is specified, a copy of disk is returned to which the file is written.

Author(s)

Pepijn de Vries

See Also

Other AmigaIcon.operations: AmigaIcon, rawToAmigaIcon(), read.AmigaIcon(), simpleAmigaIcon()

Other io.operations: read.AmigaBasicBMAP(), read.AmigaBasicShape(), read.AmigaBasic(), read.AmigaBitmapFontSet(), read.AmigaBitmapFont(), read.AmigaIcon(), read.SysConfig(), read.iff(), write.AmigaBasicShape(), write.AmigaBasic(), write.AmigaBitmapFont(), write.SysConfig(), write.iff()

Examples

## Not run: 
## create a simple AmigaIcon:
icon <- simpleAmigaIcon()

## write the icon to the temp dir:
write.AmigaIcon(icon, file.path(tempdir(), "icon.info"))

## End(Not run)

AmigaFFH documentation built on Aug. 27, 2023, 9:07 a.m.