Skip to main content

630 docs tagged with "function"

View all tags
Docs

abs

Returns the absolute value of a number.

acos

Returns the arc cosine of a number, in radians.

aliasReference

Returns the name and location of the file or folder that an alias, symbolic link, or shortcut refers to.

alternateLanguages

Returns the list of 'active scripting' languages that are installed on the system.

altKey

Returns the state of the Alt key.

annuity

Computes the value of an annuity given an interest rate and a number of payments.

arrayDecode

Converts a serialized array back into the original array.

asin

Returns the arc sine of a number in radians.

atan

Returns the arc tangent of a number in radians.

atan2

Returns the arc tangent of one number divided by another, using the sign of both.

average

Returns the arithmetic mean of a list of numbers.

backScripts

Returns a list of objects that have been inserted into the message path after the stack the target object belongs to.

base64Decode

Returns the original data from a base 64-encoded string.

baseConvert

Converts a number from one base to another.

binaryDecode

Decodes binary data and places it into the specified variables.

binaryEncode

Encodes a set of values into a set of binary values.

buildNumber

Returns the build number of the LiveCode engine.

byteOffset

Returns the byte position of the first occourence of the specified string of binary data within container of binary data.

byteToNum

Returns the numeric value of a byte.

cachedURLs

Returns a list of the URLs that have been downloaded and copied to the cache using the load command.

cameraControlGet

Gets the value of a property of a camera control created using cameraControlCreate.

cameraControls

Returns a list of all camera controls currently in existence.

ceiling

Returns the smallest integer greater than or equal to number.

cipherNames

**cipherNames** returns a list of ciphers and their associated default key lengths in bits.

clickChar

Returns the character the user last clicked in a field.

clickCharChunk

Returns the position of the character the user last clicked in a field.

clickChunk

Returns the position of the word or grouped text that the user last clicked.

clickField

Returns the number of the last field the user clicked.

clickH

Returns the horizontal position of the most recent mouse click.

clickLine

Returns the number of the line that the user last clicked in a field.

clickLoc

Returns the position of the most recent mouse click.

clickStack

Returns the name of the stack in which the user most recently clicked the mouse.

clickText

Returns the word or text group the user last clicked.

clickV

Returns the vertical position of the most recent mouse click.

clipboard

Returns the type of information on the clipboard.

codepointOffset

Returns the number of codepoints between the beginning of a value and an occurrence of a specified string.

codepointProperty

Retrieves a Unicode Character Database (UCD )character property of a Unicode codepoint.

codeunitOffset

Returns the number of codeunits between the beginning of a value and an occurrence of a specified string.

colorNames

Returns a list of the color names you can use in LiveCode.

commandArguments

If no index is given, returns a 1-based, numeric array containing all the arguments given to the command. If an index is given, returns the argument corresponding to the index (1 being the first argument).

commandName

Returns the command name used to start the execution of the application

commandNames

Returns a list of all built-in commands in LiveCode.

compound

Returns the principal plus accrued interest of an investment.

compress

Returns a gzip-compressed string.

constantNames

Returns a list of all built-in constants in LiveCode.

copyResource

Copies a resource from one Mac OS file to another.

cos

Returns the cosine of an angle (in radians).

date

Returns the current date.

dateFormat

Returns a string describing a given date format using the syntax described below.

decompress

Returns the plain text of a gzip-encoded string.

deleteResource

Removes a resource from the resource fork of a Mac OS file.

DiffCompare

Produce a diff representing the changes between two text strings

DiffPatch

Patch a string with a previously computed diff.

diskSpace

Returns the amount of free space on the disk that holds the defaultFolder.

DNSServers

Returns a list of the DNS servers listed in the system's TCP/IP network configuration.

dragDestination

Returns the long ID of the object that dragged data was dropped on.

dragSource

Returns the long ID of the object that dragged data was dragged from.

driverNames

Returns a list of available serial drivers.

dropChunk

Returns a chunk expression describing the location in the field where data was dropped.

environment

Returns the type of running environment the stack is in.

exists

Returns true if the specified object exists, false if it does not.

exp

Returns the natural exponential of a number.

exp1

Returns the natural exponential of a number, minus 1.

exp10

Returns the decimal exponential of a number.

exp2

Returns the binary exponential of a number.

extents

Returns a list of the smallest and largest keys for each dimension of an array.

files

List the files in a folder.

floor

Returns the greatest integer less than or equal to number.

flushEvents

Clears pending events from the event queue so they will not trigger handlers.

folders

List the subfolders in a folder.

fontLanguage

Returns the language associated with a Unicode font.

fontNames

Returns a list of the currently installed fonts.

fontSizes

Returns a list of the font sizes available for a specified font.

fontStyles

Returns a list of styles available for a font and size.

format

Returns a formatted string that has been transformed according to the rules of the C "printf()" function.

foundChunk

Returns a chunk expression describing the location of the text that was found by the most recent find command.

foundField

Returns the field in which text was located by the most recent find command.

foundLine

Returns a chunk expression describing the line in which text was located by the most recent find command.

foundLoc

Returns the location of the top left corner of the box that surrounds text found by the find command.

foundText

Returns the text located by the most recent find command.

frontScripts

Returns a list of objects that have been inserted into the message path before the target object.

functionNames

Returns a list of all built-in functions in LiveCode.

GetDataOfIndex

Retrieves the internal array for key pIndex of the internal array in the data grid.

GetDataOfLine

Retrieves the internal array associated with line pLine in the data grid.

GetOpt

Parse options from command line arguments Associated:GetOptLibrary

getResources

Returns a list of the resources in a Mac OS file.

globalLoc

Returns the equivalent, in absolute coordinates|global coordinates, of a point given in relative coordinates|local coordinates.

globalNames

Returns a list of declared global variables.

harmonicMean

Returns the harmonic mean of a list of numbers.

hasMemory

Returns true if the specified amount of memory is available, false otherwise.

heapSpace

Returns the number of free bytes in the application heap on Mac OS systems.

hostAddress

Returns the IP address of the local system a socket is connected to.

hostName

Returns the domain name of the local system.

interrupt

Returns true if the allowInterrupts property is false and the user has attempted to halt the current handler with a key combination.

intersect

Returns true if two objects overlap, false otherwise.

iphoneDeviceScale

Returns the scale of the device's screen(relative to a non-Retina display)

iphoneDoNotBackupFile

Returns a boolean value specifying whether or not the given file has been flagged to prevent backup.

iphoneIdentifierForVendor

Returns a unique identifier for device. The identifier is the same for all apps that come from the same vendor running of the same device.

isNumber

Returns true if a value is a number, false if it is not.

ISOToMac

Returns the equivalent of a Windows Latin 1 string, in the Mac OS character set.

itemOffset

Returns the number of items between the beginning of a value and an occurrence of a specified string.

jsonDecode

Converts a string containing JSON to a LiveCode value.

jsonDecodeUtf8

Converts a binary string, containing utf-8 encoded JSON, to a LiveCode value.

jsonEncode

Converts a value to a string in JSON format, with minimal whitespace.

jsonEncodeAscii

Converts a value to a string in JSON format, using only ASCII characters and minimal whitespace.

jsonEncodeForDisplay

Converts a value to a string in JSON format, using appropriate whitespace to make it readable.

jsonEncodeUtf8

Converts a value to JSON format, encoded as a UTF-8 binary string.

JsonExport

Converts a LiveCode value to a string in JSON format.

JsonImport

Converts a string in JSON format to a LiveCode value.

keys

Returns a list of the element names in an array.

keysDown

Returns a list of the keys currently being pressed.

length

Returns the number of characters in a string.

libURLErrorData

Returns any error that was caused during a download that was started with the load command.

libURLFormData

**libURLFormData** formats data in the standard format suitable for sending to form processing CGIs and other processes on a web server.

libURLLastRHHeaders

Returns the headers sent by the remote host in the most recent HTTP transaction.

libURLMultipartFormAddPart

This function lets you add parts to a multipart form one at a time. It also lets you optionally specify the mime type and transfer encoding for each part. This can be useful where the mime type or transfer encoding has to be specified.

licensed

Returns true if the development environment is running.

lineOffset

Returns the number of lines between the beginning of a value and an occurrence of a specified string.

listRegistry

Lists the sub-keys of the specified key in the registry|Windows system registry.

ln

Returns the natural logarithm of a number.

ln1

Returns the natural logarithm of a number plus one.

localLoc

Returns the equivalent, in relative coordinates|local coordinates, of a point given in absolute coordinates|global coordinates.

log10

Returns the base-10 logarithm of a number.

log2

Returns the base-2 logarithm of a number.

longFilePath

Returns the long-format equivalent of an 8.3-format file path.

machine

Returns the type of hardware the application is running on.

macToISO

Returns the equivalent of a Mac OS character-set string, translated into the Windows Latin 1 character set.

mainStacks

Returns a list of the main stacks that are loaded into memory.

matchChunk

Returns true if the regex pattern pattern is found in the specified string, false otherwise.

matchText

Returns true if the regex pattern pattern is found in the specified string, false otherwise.

max

Returns the largest number from a list of numbers.

MCISendString

Sends a command to the Media Control Interface system, and returns the result of the command.

md5Digest

Computes a MD5 cryptographic message digest.

measureText

Returns the width, size or bounds of the text drawn with the effective font attribute of the given object.

measureUnicodeText

Returns the width, size or bounds of the unicode text drawn with the effective font attribute of the given object.

median

Returns the median (middle number) of a list of numbers.

menuButton

Returns the name of the button that triggered display of a stack menu.

menus

Does not return a meaningful value and is included in LiveCode for compatibility with imported HyperCard stacks.

mergAccessoryNames

Returns the names of any devices connected to the device with protocols your supports

mergAnswerColor

Presents a modal color picker and returns when a color is saved or the user cancels

mergAVCanRecord

Checks if the user has authorised the app to record audio or video

mergAVEditVideo

Edits the video and saves the result in the temporary folder and returns the file path

mergAVPick

Picks a video from a recording or the library and saves it in the temporary folder and returns the file path

mergAVPlayerCreate

Create a player control from an asset or composition with an optional video composition

mergBgTaskTimeRemaining

This function returns the amount of time the application has to run in the background before it may be forcibly killed by the system

mergButtonFontNames

Required because the fontNames funtion in LiveCode doesn't return actual font names

mergCLDistanceBetween

Calculate the distance between to coordinates taking into account the curvature of the earth

mergDocCanOpen

Returns true if there is an app that can open the document type

merge

Evaluates any expressions in a string, replaces them with their value, and returns the transformed string.

mergPopMenu

Presents a popup contextual menu like the Cut|Copy|Paste menu in a text view

milliseconds

Returns the number of milliseconds since the start of the eon.

min

Returns the smallest number of a list of numbers.

mobileAds

Return a list of all mobile ads that have been created.

mobileCanTrackHeading

Returns true if the device can track the heading using a digital compass, false otherwise.

mobileControlGet

Gets the value of a property of a native mobile control created using mobileControlCreate.

mobileControls

Returns a list of all native mobile controls currently in existence.

mobileControlTarget

Fetches the name or id (if no name is set) of the native mobile control that sent the message.

mobileGetLaunchData

Returns an array containing information set by the launcher of the application.

mobileIsNFCAvailable

Returns true if the device can communicate with other NFC devices or tags, false otherwise.

mobileIsNFCEnabled

Returns true if the NFC function of the device is enabled, false otherwise.

mobilePixelDensity

Returns the pixel density of the device screen (relative to a non-Retina display)

monthNames

Returns a list of month names used by the date function.

mouse

Returns the state of a mouse button.

mouseChar

Returns the character the mouse pointer is over.

mouseCharChunk

Returns a chunk expression describing the location of the character under the mouse pointer.

mouseChunk

Returns a chunk expression describing the location of the word or text group under the mouse pointer.

mouseClick

Returns true if the user has clicked since the event that caused the current handler to run (or since the last time the **mouseClick** was checked).

mouseColor

Returns the color of the pixel that the mouse pointer is over.

mouseControl

Returns the number of the control the mouse pointer is over.

mouseH

Returns the horizontal position of the mouse pointer.

mouseLine

Returns a chunk expression describing the location of the line of text under the mouse pointer.

mouseLoc

Returns the location of the mouse pointer.

mouseStack

Returns the name of the window the mouse pointer is over.

mouseText

Returns the word or text group under the mouse pointer.

mouseV

The **mouseV** property returns the vertical position of the pointer.

movie

Returns the name of the currently playing video clip.

movingControls

Returns a list of controls that are being moved by the move command.

nativeCharToNum

Returns the 8-bit value corresponding to a native character.

normalizeText

Converts a text string into a specific 'normal form'.

number

Returns the number of objects of a certain kind, or the number of chunks in a string.

numToByte

Returns the byte corresponding to a numeric value in the range 0-255.

numToNativeChar

Returns the native character corresponding to an ASCII value.

offset

Returns the number of characters between the first character of a value and an occurrence of a specified string.

openFiles

Returns a list of files that have been opened with the open file command, but not yet closed with the close file command.

openProcesses

Returns the names of processes that have been opened with the open process command, but have not yet exited.

openProcessIDs

Returns the process IDs of processes that have been opened with the open process command, but have not yet exited.

openSockets

Returns a list of the currently open sockets.

openStacks

Returns a list of the names of all open stacks.

optionKey

Returns the state of the Option key.

paragraphOffset

Returns the number of paragraphs between the beginning of a value and an occurrence of a specified string.

param

Returns the specified parameter passed to the current handler.

paramCount

Returns the number of parameters passed to the current handler.

params

Returns all the parameters passed to the current handler.

params range

Returns a range of parameters passed to the current handler as an array.

peerAddress

Returns the IP address of the remote system at the other end of a socket.

pendingMessages

Returns a list of messages that have been scheduled with the send command, but not yet delivered.

platform

Returns the name of the operating system LiveCode is running on.

processID

Returns the process ID of LiveCode (or a standalone application).

processor

Returns a string describing the system's architecture.

productVersion

Returns the version of LiveCode Create currently running

propertyNames

Returns a list of all built-in properties in LiveCode.

queryRegistry

The **queryRegistry** function returns the value of an entry in the Windows system registry.

random

Returns a random integer.

recordLoudness

Returns the volume of the sound currently being recorded in decibels

replaceText

Searches for a regex pattern and replaces the portions that match it.

result

Is a global property returning the last value returned by return from a handler, from an engine function, or from an engine command which sets the result.

revBrowserGet

Retrieves a property from the specified browser object.

revDatabaseColumnNames

Returns the list of database field names in a record set (database cursor)(glossary) or a database table

revDatabaseID

Returns the database ID of the database that opened a record set.

revDataFromQuery

Gets records from a database according to a SQL query and places the resulting data in a variable, without creating a record set.

revIsSpeaking

Returns true or false, depending on whether a phrase is currently being spoken by the **revIsSpeaking** command.

revLoadedStacks

Returns a list of the names of all stacks that are loaded into memory.

revOpenDatabase

Connects to a MySQL, SQLite, PostgreSQL, ODBC or Oracle database.

revQueryIsAtEnd

Returns whether the end of a record set has been reached or not.

revQueryIsAtStart

Returns whether the beginning of a record set has been reached or not.

revQueryResult

Returns the most recent error message associated with a record set.

revSpeechVoices

Returns a list of available voices to use with the revSetSpeechVoice command.

revXMLAttribute

Returns the value of the specified attribute of the specified node of an XML tree.

revXMLAttributes

Returns a list of all attributes and their values for the specified node.

revXMLAttributeValues

Returns a list of the values of a specified attribute for the specified nodes in an XML tree.

revXMLChildNames

Returns a list of the child nodes under the specified node in an XML tree.

revXMLDataFromXPathQuery

pDocID is the xml document id returned from one of the revXMLCreate functions. The charDelimiter and lineDelimiter both default to cr. If neither is specified then the items will be returned one per line. For example: J. K. Rowling Harry Potter Cory Doctorow Little Brother

revXMLEvaluateXPath

The charDelimiter defaults to cr. If not specified then the items will be returned one per line. For example: J. K. Rowling Harry Potter Cory Doctorow Little Brother

revXMLMatchingNode

Finds the node in an XML tree where the specified attribute of the node has the specified value.

revXMLParent

Returns the path to the parent node of a node in an XML tree.

revXMLRPC_CreateRequest

Creates an XML-RPC request structure, optionally setting its host, port, path and protocol.

revXMLRPC_Error

If an error occurred during the execution of an XML-RPC request, this function returns the error.

revXMLRPC_Execute

Executes an XML-RPC request and returns the result as an XML-RPC document structure.

revXMLRPC_GetParamNode

Returns the node of a single parameter from an XML-RPC document structure, so you can parse the data using the XML library commands and functions.

revXMLRPC_GetRequest

This function returns the request document that was executed and resulted in the response document.

revXMLRPC_GetResponse

If the execution of an XML-RPC request was successful, this function returns the response document.

revXMLText

Returns the contents of an XML tree as XML text.

revXMLTree

Returns a list of the nodes in an XML tree, in a form that shows their parent/child relationships.

round

Rounds off a number to the nearest integer.

screenColors

Returns the number of colors the screen can display.

screenLoc

Returns the location of the screen's center.

screenName

Returns the name of the current screen.

screenRect

Returns the geometry of screens connected to the computer.

screenType

Returns the color capability of the screen.

screenVendor

Returns version information about the producer of the windowing software.

scriptLimits

Previously returned the limits on dynamic scripting in the current environment.

seconds

Returns the number of seconds since the start of the eon.

selectedButton

Returns the name of the currently highlighted button in a family.

selectedChunk

Returns a chunk expression describing the location of the text selection or insertion point.

selectedField

Returns the number of the field with the text selection or insertion point.

selectedImage

Returns the number of the image which is partly or completely selected with the Select tool.

selectedLine

Returns a chunk expression describing the line or lines in the text selection.

selectedLoc

Returns the location of the top left corner of the text selection.

sentenceOffset

Returns the number of sentences between the beginning of a value and an occurrence of a specified string.

setRegistry

Sets an entry in the Windows system registry.

setResource

Places data in a specified resource in a Mac OS file.

sha1Digest

Computes a SHA-1 cryptographic message digest.

shell

Runs a shell command and returns its output.

shiftKey

Returns the state of the Shift key.

shortFilePath

Returns the 8.3-format equivalent of a Windows long file path.

sin

Returns the sine of an angle (in radians).

sound

Returns the name of the audio clip or sound file that is currently playing.

sqrt

Returns the square root of a number.

stacks

Returns a list of stack files that contain an open stack.

stackSpace

Does not return a meaningful value and is included in LiveCode for compatibility with imported HyperCard stacks.

sum

Returns the sum of a list of numbers.

sysError

Returns the operating system's error status.

systemVersion

Returns the version number of the operating system.

tan

Returns the tangent of an angle (in radians).

target

Returns the object which received the message that started execution.

tempName

Returns a unique file name in the folder the operating system uses for temporary files.

textHeightSum

Returns the total height of the text in a field or button.

ticks

Returns the number of ticks since the start of the eon.

time

Returns the current time.

tokenOffset

Returns the number of tokens between the beginning of a value and an occurrence of a specified string.

toLower

Returns a string converted to all lowercase letters.

tool

Returns the name of the currently chosen tool.

topStack

Returns the long name of the topmost stack.

toUpper

Returns a string converted to all uppercase letters.

transpose

Returns a two-dimensional array after swapping the order of keys for each element of the array.

truewordOffset

Returns the number of truewords between the beginning of a value and an occurrence of a specified string.

trunc

Returns the integer part of a number.

tsNetCustom

Send an asynchronous custom request to a server.

tsNetCustomUpload

Send an asynchronous upload request to a server using a custom request method.

tsNetCustomUploadFile

Send an asynchronous upload request to a server which retrieves the data to be sent directly from a file using a custom request method.

tsNetCustomUploadFileSync

Send a synchronous upload request to a server which retrieves the data to be sent directly from a file using a custom request method.

tsNetGenerateKey

Generates an RSA public/private key for use with SFTP transfers.

tsNetGet

Send an asynchronous GET request to a server.

tsNetGetFile

Send an asynchronous GET request to a server which stores the returned data directly to a file.

tsNetGetFileSync

Send a synchronous GET request to a server which stores the returned data directly to a file.

tsNetHead

Send an asynchronous request to a server specifying that no body be transferred.

tsNetHeadSync

Send a synchronous request to a server specifying that no body be transferred.

tsNetPost

Send an asynchronous POST request to a server.

tsNetSendCmd

Send an asynchronous command to a FTP or SFTP server.

tsNetSmtp

Send an asynchronous upload request to a server.

tsNetSmtpFile

Send an asynchronous upload request to a server which retrieves the data to be sent directly from a file.

tsNetSmtpFileSync

Send a synchronous upload request to a server which retrieves the data to be sent directly from a file.

tsNetUpload

Send an asynchronous upload request to a server.

tsNetUploadFile

Send an asynchronous upload request to a server which retrieves the data to be sent directly from a file.

tsNetUploadFileSync

Send a synchronous upload request to a server which retrieves the data to be sent directly from a file.

uniDecode

Converts a string from Unicode to single-byte text.

uniEncode

Converts a string from single-byte text to Unicode.

URLDecode

Returns the decoded form of a URL that was encoded for posting to an HTTP server.

URLEncode

Returns a string that has been transformed so that it can be posted to an HTTP server as a URL.

URLStatus

Returns the status of uploads and downloads that were started with the load, libURLDownloadToFile, libURLftpUpload, and libURLftpUploadFile commands.

uuid

Genrates a universally unique identifier (UUID)

value

Returns the value of an expression.

variableNames

Returns a list of all parameters, local variables, and global variables.

variance

Returns the sample variance of a list of numbers.

version

Returns the version of LiveCode Create currently running but with a value which is compatible with version checks in existing LiveCode script.

waitDepth

Returns the number of nested wait commands currently pending.

weekdayNames

Returns a list of names of the days of the week used by the date function.

within

Returns true if a point is within an object, false if not.

wordOffset

Returns the number of words between the beginning of a value and an occurrence of a specified string.

xsltApplyStylesheet

Returns the data set resulting from applying the xslt document against the specified xml document.

xsltApplyStylesheetFromFile

Returns the data set resulting from applying the xslt document in the specified file against the specified xml document.

xsltLoadStylesheet

The xsltLoadStylesheet function loads an xslt stylesheet into memory from xml data so that it can be applied to xml data using the xsltApplyStylesheet function. It returns an xslt stylesheet id.

xsltLoadStylesheetFromFile

The xsltLoadStylesheetFromFile function loads an xslt stylesheet into memory from a file so that it can be applied to xml data using the xsltApplyStylesheet function. It returns an xslt stylesheet id.