#cp.tools
A collection of handy miscellaneous tools for Lua development.
#API Overview
Functions - API calls offered directly by the extension
- appleScriptViaTask
- between
- camelCase
- centre
- characterToPercentEncodedString
- cleanupButtonText
- contentsInsideBrackets
- convertSingleHexStringToDecimalString
- desktopPath
- dirFiles
- doesDirectoryExist
- doesFileExist
- doubleLeftClick
- encodeURI
- encodeURIComponent
- endsWith
- ensureDirectoryExists
- escapeTilda
- exactMatch
- executeWithAdministratorPrivileges
- fileLinesBackward
- findCommonWordWithinTwoStrings
- firstToUpper
- getEmail
- getExternalDevices
- getFileExtensionFromPath
- getFilenameFromPath
- getFullname
- getKeysSortedByValue
- getmacOSVersion
- getModelName
- getRAMSize
- getScreenshotsAsBase64
- getThunderboltDevices
- getUSBDevices
- getVRAMSize
- hexStringToString
- iconFallback
- incrementFilename
- incrementFilenameInPath
- isColor
- isImage
- isNumberString
- isOffScreen
- keyStroke
- leftClick
- lines
- lower
- macOSVersion
- mergeTable
- ninjaDoubleClick
- ninjaMouseAction
- ninjaMouseClick
- ninjaRightMouseClick
- numberToWord
- optionPressed
- playErrorSound
- pressSystemKey
- readFromFile
- removeFilenameFromPath
- removeFromTable
- replace
- rescale
- rightClick
- rmdir
- round
- safeFilename
- secureInputApplicationTitle
- shiftPressed
- spairs
- split
- splitOnColumn
- startsWith
- stringMaxLength
- stringToHexString
- tableContains
- tableCount
- tableFilter
- tableMatch
- toRegionalNumber
- toRegionalNumberString
- trim
- unescape
- upper
- urlQueryStringDecode
- urlToFilename
- volumeFormat
- writeToFile
#API Documentation
#Functions
Signature | cp.tools.appleScriptViaTask(script) -> none |
Type | Function |
Description | Triggers an AppleScript command via hs.task to avoid potential memory leaks in hs.osascript.applescript . |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 203 |
Signature | cp.tools.between(value, min, max) -> boolean |
Type | Function |
Description | Is a value between the minimum and the maximum value? |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 188 |
Signature | cp.tools.camelCase(str) -> string |
Type | Function |
Description | Converts the supplied string to camelcase. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2162 |
Signature | cp.tools.centre(frame) -> hs.geometry point |
Type | Function |
Description | Gets the centre point of a frame. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1655 |
Signature | cp.tools.characterToPercentEncodedString(input) -> string |
Type | Function |
Description | Encodes a character as a percent encoded string. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2505 |
Signature | cp.tools.cleanupButtonText(value) -> string |
Type | Function |
Description | Removes the … symbol and multiple >'s from a string. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1966 |
Signature | cp.tools.contentsInsideBrackets(value) -> string | nil |
Type | Function |
Description | Gets the contents of any text inside the first bracket set. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2425 |
Signature | cp.tools.convertSingleHexStringToDecimalString(hex) -> string |
Type | Function |
Description | Converts a single hex string (i.e. "3") to a binary string (i.e. "0011") |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2314 |
Signature | cp.tools.desktopPath() -> string |
Type | Function |
Description | Gets the users Desktop Path |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 112 |
Signature | cp.tools.dirFiles(path) -> table |
Type | Function |
Description | Gets all the files in a directory |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2041 |
Signature | cp.tools.doesDirectoryExist(path) -> boolean |
Type | Function |
Description | Returns whether or not a directory exists. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1494 |
Signature | cp.tools.doesFileExist(path) -> boolean |
Type | Function |
Description | Returns whether or not a file exists. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1512 |
Signature | cp.tools.doubleLeftClick(point[, delay]) -> none |
Type | Function |
Description | Performs a Left Mouse Double Click. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1706 |
Signature | cp.tools.encodeURI(input) -> string |
Type | Function |
Description | Replaces all characters (except for those listed in the notes) with the appropriate UTF-8 escape sequences. |
Parameters |
|
Returns |
|
Notes |
|
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2518 |
Signature | cp.tools.encodeURIComponent(input) -> string |
Type | Function |
Description | Escapes all characters (except for those listed in the notes) with the appropriate UTF-8 escape sequences. |
Parameters |
|
Returns |
|
Notes |
|
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2534 |
Signature | cp.tools.endsWith(str, ending) -> boolean |
Type | Function |
Description | Checks to see if str has the same ending as ending . |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2214 |
Signature | cp.tools.ensureDirectoryExists(rootPath, ...) -> string | nil |
Type | Function |
Description | Ensures all steps on a provided path exist. If not, attempts to create them. If it fails, nil is returned. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2229 |
Signature | cp.tools.escapeTilda(input) -> string |
Type | Function |
Description | Escapes a tilda. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 255 |
Signature | cp.tools.exactMatch(value, pattern, plain, ignoreCase) -> boolean |
Type | Function |
Description | Compares two strings to see if they're an exact match. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2366 |
Signature | cp.tools.executeWithAdministratorPrivileges(input[, stopOnError]) -> boolean or string |
Type | Function |
Description | Executes a single or multiple shell commands with Administrator Privileges. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1564 |
Signature | cp.tools.fileLinesBackward(filename) -> function |
Type | Function |
Description | An iterator function that reads a file backwards. |
Parameters |
|
Returns |
|
Notes |
|
Examples | None |
Source | src/extensions/cp/tools/init.lua line 142 |
Signature | cp.tools.findCommonWordWithinTwoStrings(a, b) -> string |
Type | Function |
Description | Finds a common word within two strings. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 661 |
Signature | cp.tools.firstToUpper(str) -> string |
Type | Function |
Description | Makes the first letter of a string uppercase. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2182 |
Signature | cp.tools.getEmail() -> string |
Type | Function |
Description | Returns the current users Email, otherwise an empty string. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1313 |
Signature | cp.tools.getExternalDevices() -> string |
Type | Function |
Description | Returns a string of USB & Thunderbolt Devices. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1282 |
Signature | cp.tools.getFileExtensionFromPath(input) -> string |
Type | Function |
Description | Gets the file extension from a path. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1913 |
Signature | cp.tools.getFilenameFromPath(input[, removeExtension]) -> string |
Type | Function |
Description | Gets the filename component of a path. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1890 |
Signature | cp.tools.getFullname() -> string |
Type | Function |
Description | Returns the current users Full Name, otherwise an empty string. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1295 |
Signature | cp.tools.getKeysSortedByValue(tbl, sortFunction) -> table |
Type | Function |
Description | Sorts table keys by a value |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 501 |
Signature | cp.tools.getmacOSVersion() -> string |
Type | Function |
Description | Returns the macOS Version in the format that Apple's Feedback Form expects. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 950 |
Signature | cp.tools.getModelName() -> string |
Type | Function |
Description | Returns Model Name of Hardware. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 743 |
Signature | cp.tools.getRAMSize() -> string |
Type | Function |
Description | Returns RAM Size in a format Apple's Feedback form expects. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 710 |
Signature | cp.tools.getScreenshotsAsBase64() -> table |
Type | Function |
Description | Captures all available screens and saves them as base64 encodes in a table. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1361 |
Signature | cp.tools.getThunderboltDevices() -> string |
Type | Function |
Description | Returns a string of Thunderbolt Devices. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1235 |
Signature | cp.tools.getUSBDevices() -> string |
Type | Function |
Description | Returns a string of USB Devices. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1206 |
Signature | cp.tools.getVRAMSize() -> string |
Type | Function |
Description | Returns the VRAM size in format suitable for Apple's Final Cut Pro feedback form or "" if unknown. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 881 |
Signature | cp.tools.hexStringToString(value) -> string |
Type | Function |
Description | Converts a hex string to a string. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2407 |
Signature | cp.tools.iconFallback(paths) -> string |
Type | Function |
Description | Excepts one or more paths to an icon, checks to see if they exist (in the order that they're given), and if none exist, returns the CommandPost icon path. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2195 |
Signature | cp.tools.incrementFilename(value) -> string |
Type | Function |
Description | Increments the filename. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1996 |
Signature | cp.tools.incrementFilenameInPath(path) -> string |
Type | Function |
Description | Increments the filename as it appears in a path. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2015 |
Signature | cp.tools.isColor(object) -> boolean |
Type | Function |
Description | Is the supplied object an hs.drawing.color ? |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2492 |
Signature | cp.tools.isImage(object) -> boolean |
Type | Function |
Description | Is the supplied object an hs.image ? |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2479 |
Signature | cp.tools.isNumberString(value) -> boolean |
Type | Function |
Description | Returns whether or not value is a number string. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 683 |
Signature | cp.tools.isOffScreen(rect) -> boolean |
Type | Function |
Description | Determines if the given rect is off screen or not. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1401 |
Signature | cp.tools.keyStroke(modifiers, character, app, proper) -> none |
Type | Function |
Description | Generates and emits a single keystroke event pair for the supplied keyboard modifiers and character to the application. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 268 |
Signature | cp.tools.leftClick(point[, delay, clickNumber]) -> none |
Type | Function |
Description | Performs a Left Mouse Click. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1668 |
Signature | cp.tools.lines(string) -> table | nil |
Type | Function |
Description | Splits a string containing multiple lines of text into a table. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1538 |
Signature | cp.tools.lower(str) -> string |
Type | Function |
Description | Converts the supplied string to lowercase. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2147 |
Signature | cp.tools.macOSVersion() -> string |
Type | Function |
Description | Returns a the macOS Version as a single string. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1479 |
Signature | cp.tools.mergeTable(target, ...) -> table |
Type | Function |
Description | Merges multiple tables into a target table. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 570 |
Signature | cp.tools.ninjaDoubleClick(point[, delay]) -> none |
Type | Function |
Description | Performs a mouse double click, but returns the mouse to the original position without the users knowledge. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1758 |
Signature | cp.tools.ninjaMouseAction(point, fn) -> none |
Type | Function |
Description | Moves the mouse to a point, performs a function, then returns the mouse to the original point. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1776 |
Signature | cp.tools.ninjaMouseClick(point[, delay]) -> none |
Type | Function |
Description | Performs a mouse click, but returns the mouse to the original position without the users knowledge. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1722 |
Signature | cp.tools.ninjaRightMouseClick(point[, delay]) -> none |
Type | Function |
Description | Performs a right mouse click, but returns the mouse to the original position without the users knowledge. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1740 |
Signature | cp.tools.numberToWord(number) -> string |
Type | Function |
Description | Converts a number to a string (i.e. 1 becomes "One"). |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2108 |
Signature | cp.tools.optionPressed() -> boolean |
Type | Function |
Description | Is the Option Key being pressed? |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 389 |
Signature | cp.tools.playErrorSound() -> none |
Type | Function |
Description | Plays the "Funk" error sound. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2261 |
Signature | cp.tools.pressSystemKey(key) -> none |
Type | Function |
Description | Virtually presses a system key. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 335 |
Signature | cp.tools.readFromFile(path) -> string |
Type | Function |
Description | Read data from file. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 423 |
Signature | cp.tools.removeFilenameFromPath(string) -> string |
Type | Function |
Description | Removes the filename from a path. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1929 |
Signature | cp.tools.removeFromTable(table, element) -> table |
Type | Function |
Description | Removes a string from a table of strings |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1870 |
Signature | cp.tools.replace(textValue, old, new) -> string |
Type | Function |
Description | A find and replace feature that doesn't use patterns. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2445 |
Signature | cp.tools.rescale(value, inMin, inMax, outMin, outMax) -> number | nil |
Type | Function |
Description | Takes an input, rescales it, and provides a new output. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 479 |
Signature | cp.tools.rightClick(point[, delay, clickNumber]) -> none |
Type | Function |
Description | Performs a Right Mouse Click. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1687 |
Signature | cp.tools.rmdir(path[, recursive]) -> true | nil, err |
Type | Function |
Description | Attempts to remove the directory at the specified path, optionally removing any contents recursively. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2069 |
Signature | cp.tools.round(num, numDecimalPlaces) -> number |
Type | Function |
Description | Rounds a number to a set number of decimal places |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1386 |
Signature | cp.tools.safeFilename(value[, defaultValue]) -> string |
Type | Function |
Description | Returns a Safe Filename. |
Parameters |
|
Returns |
|
Notes |
|
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1425 |
Signature | cp.tools.secureInputApplicationTitle() -> string |
Type | Function |
Description | Gets the title of the first application that has 'Secure Input' enabled. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 221 |
Signature | cp.tools.shiftPressed() -> boolean |
Type | Function |
Description | Is the Shift Key being pressed? |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 371 |
Signature | cp.tools.spairs(t, order) -> function |
Type | Function |
Description | A customised version of pairs, called spairs because it iterates over the table in a sorted order. |
Parameters |
|
Returns |
|
Notes |
|
Examples | None |
Source | src/extensions/cp/tools/init.lua line 522 |
Signature | cp.tools.split(str, pat) -> table |
Type | Function |
Description | Splits a string with a pattern. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 632 |
Signature | cp.tools.splitOnColumn() -> string |
Type | Function |
Description | Splits a string on a column. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 696 |
Signature | cp.tools.startsWith(value, startValue) -> boolean |
Type | Function |
Description | Checks to see if a string starts with a value. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2345 |
Signature | cp.tools.stringMaxLength(string, maxLength[, optionalEnd]) -> string |
Type | Function |
Description | Trims a string based on a maximum length. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1942 |
Signature | cp.tools.stringToHexString(value) -> string |
Type | Function |
Description | Converts a string to a hex string. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2390 |
Signature | cp.tools.tableContains(table, element) -> boolean |
Type | Function |
Description | Does a element exist in a table? |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1815 |
Signature | cp.tools.tableCount(table) -> number |
Type | Function |
Description | Returns how many items are in a table. |
Parameters |
|
Returns |
|
Notes |
|
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1793 |
Signature | cp.tools.tableFilter(t, matchFn) -> table |
Type | Function |
Description | Efficiently filters out all elements from the table t which to not match the matchFn . |
Parameters |
|
Returns |
|
Notes |
|
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1838 |
Signature | cp.tools.tableMatch(t1, t2[, ignoreMetatable]) -> boolean |
Type | Function |
Description | Compares two tables. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2274 |
Signature | cp.tools.toRegionalNumber(value) -> number | nil |
Type | Function |
Description | Takes a string and converts it into a number, with the correct regional decimal separator. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 441 |
Signature | cp.tools.toRegionalNumberString(value) -> string | nil |
Type | Function |
Description | Takes a number and converts it into a string, with the correct regional decimal separator. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 460 |
Signature | cp.tools.trim(string) -> string |
Type | Function |
Description | Trims the whitespaces from a string |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1525 |
Signature | cp.tools.unescape(str) -> string |
Type | Function |
Description | Removes any URL encoding in the provided string. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 619 |
Signature | cp.tools.upper(str) -> string |
Type | Function |
Description | Converts the supplied string to uppercase. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 2132 |
Signature | cp.tools.urlQueryStringDecode() -> string |
Type | Function |
Description | Decodes a URL Query String |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 1346 |
Signature | cp.tools.urlToFilename(url) -> string |
Type | Function |
Description | Converts a URL to a filename. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 125 |
Signature | cp.tools.volumeFormat(path) -> string |
Type | Function |
Description | Gives you the file system volume format of a path. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 600 |
Signature | cp.tools.writeToFile(path, data) -> none |
Type | Function |
Description | Write data to a file at a given path. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/tools/init.lua line 407 |