recursal/Fanatic-Fandom huggingface dataset:
CardIDs

Reports the cards in a stack or the cards that a specified group appears on.Syntax:

```
get the cardIDs of {group | stack}

```

Examples:

```
get line 2 to 5 of the cardIDs of this stack

```

```
repeat with y = 1 to the number of lines of the cardIDs of this stack

```

```
get the cardIDs of group "navigation"

```

Use the **cardIDs** property to find out which cards are in the stack, or
to find out which card IDs have already been used.

Each line of the **cardIDs** contains the short id of a card.

The **cardIDs** of a group returns the short ids of all the cards the
group is placed on.
AutoHilite

Specifies whether a button highlights when it's pressed, or whether selected text in a field is highlighted.Syntax:

```
set the autoHilite of {<button> | <field>} to {true | false}

```

Examples:

```
set the autoHilite of last button to false

```

```
if the autoHilite of me is false then beep

```

Use the **autoHilite** property to give visual feedback to users when
they click a field(keyword) or button(keyword).

If a button's **autoHilite** property is true, clicking it changes its
appearance. This provides visual feedback to the user. (The exact change
in appearance depends on the style property of the button(keyword)
and on the current setting of the lookAndFeel property.)

The button remains highlighted while the mouse is within it and the
mouse button is down. If the user moves the mouse outside the button
while keeping the mouse button depressed, the button becomes
unhighlighted. If the user then moves the mouse back over the button,
the button becomes highlighted again.

While the button is highlighted, its hilite property is also set to
true.

If the button's style property is "checkbox" or "radioButton",
clicking it turns the control on or off. If the
button's style is menu, the **autoHilite** has no
effect.

If a field's **autoHilite** property is true, the user can move the text
selection by clicking in the field(keyword), and text
selected with the select command is highlighted. If the
field's **autoHilite** is false, user actions cannot
change the selection or place the insertion point in the
field(keyword) by clicking, although a handler can do so with the
select command and the user can do so with the arrow keys.

If a field whose listBehavior property is true also has its
**autoHilite** property set to false, list behavior does not work for
the field, and a clicked line does not highlight.

See also: field (object),button (object),showHilite (property),style (property),hilitedButtonName (property),listBehavior (property),lookAndFeel (property),selected (property),
Character

Designates a single character as part of a chunk expression.

Bezeichnet ein einzelnes Zeichen als Teil eines Chunk-Ausdrucks.

Synonym: char

Examples:

```
get char 1 of field "Answers"

```

```
put char 12 to 14 of it into oldAnswer

```

Use the character keyword to refer to a specific character or characters in a container.

(Verwenden Sie das Schlüsselwort Zeichen, um auf ein oder mehrere bestimmte Zeichen in einem Container zu verweisen.)

A character refers to what would naturally be thought of as a single graphical character, even if it is composed of multiple sub-units, as in some accented text or Korean ideographs.

The hierarchy of the new and altered chunk types is as follows:

```
byte w of codeunit x of codepoint y of char z of word ...

```

Note: In versions prior to 7.0 the byte chunk was identical in functionality to the character chunk. In 7.0 and later a character is not an 8-bit unit and it is (it's 16bit), therefore not appropriate to use this type of chunk expression on binary data, to refer to 8-bit units in binary data use the byte keyword.

See also: chars, codepoint, codeunits, line, word, codepoints, bytes, byte, codeunit
AutoArm

Specifies whether a button becomes armed when the mouse pointer moves into it.Syntax:

```
set the autoArm of <button> to {true | false}

```

Examples:

```
set the autoArm of last button to false

```

```
set the autoArm of button "Menu Choices" to true

```

Use the **autoArm** property to provide visual feedback to the user
about which button the mouse pointer is over. Usually, the **autoArm**
property is used for buttons that are part of [[stack
menu|stack menus]].

A button whose **autoArm** property is set to true does not receive
mouseDown messages.

If a button's **autoArm** property is true, it receives keyDown and
keyUp messages for keypresses that occur while the mouse is
pressed and the pointer is over the button(keyword). If the
button's **autoArm** is false, it does not receive key
messages while being clicked.

See also: mouseDown (message),keyDown (message),keyUp (message),button (object),showHilite (property),armed (property),armFill (property),armedIcon (property),
Backdrop

Places a solid or patterned background behind the application's windows, hiding any other applications.Syntax:

```

```

Examples:

```
set the backdrop to "black"

```

```
set the backdrop to "140,30,30"

```

```
set the backdrop to none -- removes the backdrop

```

Use the **backdrop** property to create a kiosk mode, or to limit
distractions during a movie or similar presentation.

Hiding other applications from the user is usually not recommended,
since users may need or want to see other windows on their system.
However, the ability to do this can be very useful for some applications
(such as kiosk systems or games) or at times when you want to reduce
distractions (such as during the playing of a movie).

Setting the **backdrop** property to "none" eliminates the backdrop and
lets other windows be seen.

Pattern images can be color or black-and-white.

```
To be used as a pattern on Mac OS
systems, an image must be 128x128 pixels or less, and both its

```

height and width must be a power of 2. To be used on Windows and
Unix systems, height and width must be divisible by 8. To
be used as a fully cross-platform pattern, both an image's dimensions
should be one of 8, 16, 32, 64, or 128.

```
On Mac OS systems, if you use the

```

launch or open process commands to start up another
application, or if the user brings another application to the front,
its windows appear in front of the backdrop. (The backdrop remains
visible even if the application is in the background.) Bringing the
application to the front again hides the other application behind
the backdrop. On Unix and Windows systems, any windows you
open after setting the **backdrop** property remain in front of the
backdrop, even if they belong to an application that is in the
background.

If the system has multiple screens connected, the **backdrop** property
affects only the main screen.

Changes:
The backdrop pattern option was introduced in version 1.1. In previous
versions, the backdrop could be a solid color, but not a pattern.

See also: clickStack (function),stacks (function),mouseUpInBackdrop (message),raiseWindows (property),height (property),pixels (property),width (property),
CursorMovement

Sets the mechanism for moving the cursor in fields containing both left-to-right and right-to-left text.Syntax:

```
set the cursorMovement of field to {visual | logical | empty}

```

Examples:

```
set the cursorMovement of field "example" to "visual"

```

Use the **cursorMovement** property to set the mechanism that is to be
used for moving the cursor in a field.

The **cursorMovement** property sets the mechanism that is to be used for
moving the cursor in fields containing both left-to-right and
right-to-left text.

The "visual" cursor movement mechanism moves the cursor in visual order,
i.e pressing left will always move the cursor one position to the left.
This is the default cursor movement on OS X.

The "logical" cursor movement moves the cursor to the next character in
logical (reading) order when the left arrow is pressed and to the
previous logical character when the right arrow is pressed. This is the
default cursor movement on Windows.

Setting the **cursorMovement** property to empty indicates that the engine
should use the default behaviour for the platform that it is being run
on.

Parameters:

* mechanism (enum): The mechanism to be used used for moving the cursor in a field
* - "visual": moves the cursor in visual order - "logical": moves the cursor to the next character in logical (reading) order- "empty": moves the cursor using the default behavior on the current platform
* Description:Use the **cursorMovement** property to set the mechanism that is to beused for moving the cursor in a field.
Accept

Accepts an internet connection and creates a socket for that connection.
Syntax

```
 accept [datagram] connections on port portNumber with message callbackMessage

```

Example:

```
on mouseUp
  accept connections on port 80 with message "connectionMade"
end mouseUp

on connectionMade pIPAddress
  put "Connection made:" && pIPAddress
end connectionMade

```

### Parameters

* callbackMessage: The name of a message to be sent when a connection is made or a datagram is received.
* portNumber: The TCP port number on which to accept connections.

Use the *accept* command when running a server, to accept TCP connections or UDP datagrams from other systems (or other processes on the same system).

Use the *datagram* option if you want to accept UDP datagrams.

When a connection is made or a datagram is received, the accept command creates a new socket that can be used to communicate with the other system (or process). When using the close socket, read from socket, or write to socket commands, you can refer to this socket with a socket identifier that looks like this:

```
host:port[|connectionID]

```

where the connectionID is a number assigned by the *accept* command. (You only need to specify the connection number if there is more than one socket connected to a particular port and host.)

The **callbackMessage** is sent to the object whose script contains the accept command. Either one or two parameters are sent with this message. The first parameter is the IP address of the system or process making the connection. If a datagram is being accepted, the second parameter is the contents of the datagram.

For technical information about sockets, see RFC 147 at http://www.ietf.org/rfc/rfc147.txt.

For technical information about UDP datagrams, see RFC 768 at http://www.ietf.org/rfc/rfc0768.txt.

For technical information about the numbers used to designate standard ports, see the list of port numbers at http://www.iana.org/assignments/port-numbers, in particular the section entitled "Well Known Port Numbers".
Create card

Makes a new card with the same background(s) as the current card.

Examples:

```
create card

```

```
create card "Main"

```

```
create card (field "ouput")

```

Use the create **card command** to add a new card to the current stack.

The *cardName* is the name property of the new card. If you don't specify a cardName, the new card's name is empty.

The new card is placed after the current card in the defaultStack. When the card is created, you go to the new card.

Any groups on the current card whose backgroundBehavior is set to true will be placed on the newly-created card automatically.

The create card command places the ID property of the newly created card in the it variable.

To create a card in a specific stack, first set the defaultStack to the stack where you want to create the new card:
Angle

Specifies the starting angle of an arc or the rotation angle of a regular polygon or image.Syntax:

```
set the angle of {<graphic> | <image>} to <angleInDegrees>

```

Examples:

```
set the angle of graphic "Triangle" to 180

```

```
set the angle of image ID 45902 to it

```

```
set the angle of graphic myGraphic to the angle of myGraphic + 5

```

Use the **angle** property to create an arc shape, or to turn a [[regular
polygon]] or image object.

If you specify an angleInDegrees greater than 360, the **angle** is set
to the number you specify mod 360.

A regular polygon can be rotated between zero and 360. Increasing the
angleInDegrees rotates the polygon clockwise. You can specify the
**angle** of a graphic(keyword) that is not a regular polygon, but it
has no effect on the graphic's appearance.

An image can be rotated between zero and 360. Increasing the
angleInDegrees rotates the image counterclockwise. Unlike the
rotate command, the **angle** property affects only the screen
display of the image, not the actual picture data in it. Changing an
image's **angle** does not change the imageData of the
image. Repeated changes to the **angle** property, unlike repeated
uses of the rotate command, do not degrade the
image's quality. The rotate command cannot be used
on a referenced image, but the **angle** of a
referenced image can be set.

By default, oval graphics display their entire arc from zero to 360,
forming a complete oval. You can use the **angle** and arcAngle
properties to specify a portion of the oval to be displayed. The
**angle** property determines the starting point of the arc. Zero is at
the right edge, 3 o'clock. Increasing the **angle** moves the starting
point counter-clockwise around the arc. (The direction of rotation for
an arc is opposite the direction of rotation for a polygon.) For
example, if the **angle** is 90, the arc starts at the top edge of the
graphic's rectangle, 12 o'clock.

For an oval, the **angle** is the same as the startAngle.
Changing one changes the other.

Changes:
The ability to set the angle of an image was introduced in version 2.0.
In previous versions, the angle property applied only to graphics.

See also: image (object),graphic (object),imageData (property),properties (property),arcAngle (property),startAngle (property),
AdExpandStart

Sent whan an ad is about to expand.Syntax:

```
adExpandStart <adName>

```

Examples:

```
on adExpandStart pAdName
   hide group "content"
end adExpandStart

```

Handle the **adExpandStart** message if you want to perform an action when
an ad is about to expand.

The **adExpandStart** messge is sent to the current card when an ad is
about to expand.

Parameters:

* adName: The name of ad that has been expanded (as specified in mobileAdCreate)

See also: mobileAdDelete (command),adLoaded (message),adLoadFailed (message),adExpandEnd (message),
Auto hilite

If a button's autoHilite property is true, clicking it changes its appearance. This provides visual feedback to the user. (The exact change in appearance depends on the style property of the button and on the current setting of the lookAndFeel property.)

The button remains highlighted while the mouse is within it and the mouse button is down. If the user moves the mouse outside the button while keeping the mouse button depressed, the button becomes unhighlighted.  If the user then moves the mouse back over the button, the button becomes highlighted again.

While the button is highlighted, its hilite property is also set to true.

If the button's style property is "checkbox" or "radioButton", clicking it turns the control on or off. If the button's style is menu, the autoHilite has no effect.

If a field's autoHilite property is true, the user can move the text selection by clicking in the field, and text selected with the select command is highlighted. If the field's autoHilite is false, user actions cannot change the selection or place the insertion point in the field by clicking, although a handler can do so with the select command and the user can do so with the arrow keys.

If a field whose listBehavior property is true also has its autoHilite property set to false, list behavior does not work for the field, and a clicked line does not highlight.
Change mouse pointer icon just on some element

It's very common to realize some elements (button, border, links) that need a change of pointer over them, for example the link text change mouse to an hand:

 Datei:MouseIcon.jpg
The code to realize that is very simple:

```
on mouseenter
     set the cursor to hand
     lock cursor
end mouseenter

on mouseleave
     unlock cursor
end mouseleave

on MouseUp
   revMail "angerangel@gmail.com"
end MouseUp

```
Android: font issues

If you encounter problems with the fonts of your app, use the command:

```
set the theme of pObject to "legacy"

```

See Theme for more information

TTF is always been supported. OTF was later added at least in 1.6 and later, but partially. Some TTF fonts Android doesn't like.

TO add fonts, just put the TTF font in the **copy file** section of the standalone application settings.
Beep

Sounds the system beep.

Syntax:

```
beep [numberOfTimes]

```

Examples:

```
beep

```

```
beep 7

```

```
beep trunc(field "Severity Level")

```

Use the beep command to get the user's attention.
Parameters:

* **numberOfTimes** - An integer (or an expression that evaluates to an integer) and specifies how many beeps are sounded. If the numberOfTimes is not specified, one beep is sounded.

If the numberOfTimes is less than 1, the beep command has no effect (but does not cause a script error).

**Cross-platform note:** Windows and OS X do not execute the beep command if it's issued while a beep is playing. This means that if you specify a numberOfTimes on a Windows or OS X system, the user might hear fewer beeps because not all of them are sent to the speaker. To ensure that the user hears a specific number of beeps, use a loop with a wait command (where the wait time is at least as long as the beep sound's duration) after each beep:

**Notes:**

* Overuse of the beep command has been known to cause user stress.
* The iPhone has no default system alert sound so if a sound is required one must be specified using the beepSound property. The action of beep is controlled by the system and depends on the user's preference settings. In particular a beep will only cause a vibration if the user has enabled that feature. Similarly, a beep will only cause a sound if the phone is not in silent mode.
* Android tries to use the default NOTIFICATION sound or uses the RINGTONE sound, if the NOTIFICATION sound is not available.
AdLoaded

Sent when an ad had loaded (or reloaded).Syntax:

```
adLoaded <adName>, <default>

```

Examples:

```
on adLoaded pAd
   enable button "move next"
end adLoaded

```

Handle the **adLoaded** message if you want to perform an action when an
ad finishes loading.

The **adLoaded** messge is sent to the object that created the ad when the
ad has loaded, or reloaded.

Parameters:

* adName: The name of ad that has loaded (as specified in mobileAdCreate)
* default (bool): True or false, specifying if the loaded ad is a default ad.

See also: mobileAdSetVisible (command),mobileAdSetTopLeft (command),mobileAdRegister (command),mobileAdGetTopLeft (function),mobileAdGetVisible (function),adClicked (message),adLoadFailed (message),
Cross

Equivalent to the number 7.Syntax:

```
cross

```

Examples:

```
set the cursor to cross

```

Use the **cross** constant to set the cursor(property) to a crosshairs
shape, suitable for selecting a rectangular area.

The following two statements are equivalent:

```
   set the cursor to cross
   set the cursor to 7

```

However, the first is easier to read and understand in LiveCode.

```
If you use the **cross** cursor(property) or other

```

standard cursors in your application, you must
include it when you create your standalone.
Make sure the "Cursors" option on the Inclusions section on the
General screen of the Standalone Application Settings window is
checked.

See also: cursor (property),
BlinkRate

Specifies the interval in milliseconds between the time the insertion point blinks on and the time it blinks off.Syntax:

```
set the blinkRate to <blinkDelayInMilliseconds>

```

Examples:

```
set the blinkRate to 1000

```

```
if the blinkRate > 400 then set the borderColor to red

```

Use the **blinkRate** property to control how fast the text [[insertion
point]] blinks.

The **blinkRate** should be a multiple of the idleRate.

See also: idleRate (property),syncRate (property),typingRate (property),
Base64Encode

Returns a base 64 encoded string.

Syntax:

```
base64Encode(<data>)

```

Examples:

```
write base64Encode(pictureFileData) to socket thisSocket

```

Use the **base64Encode** function to encode binary data
for transmission over communication channels that don't accept raw
binary data.

The **base64Encode** function is the inverse of the base64Decode
function. The encoded result is generally about a third
larger than the original data. The encoded string returned by
**base64Encode** function can include uppercase and lowercase letters,
digits, +, /, and =, but no other characters. Base 64-encoded data is
wrapped at 72 characters, so each line of the encoded data is
72 characters or (for the last or only line) fewer. The base 64
encoding scheme is often used to encode binary data for MIME mail and
HTTP transfers.

For technical information about base 64 encoding, see [RFC 2045, section
6.8]

Parameters:

* data (string): A string of binary data of any length.
* Returns: The **base64Encode** function returns a text string representing the binary data.

See also: md5Digest (function), base64Decode (function),
Click

Simuliert einen Mausklick.

Syntax:

```
click [button mouseButtonNumber] at point [with key [,key [,key]]]

```

Beispiel:

```
click at "100,200"

```

```
click button 2 at the loc of field 1

```

```
click at the mouseLoc with controlKey

```

```
click button 2 at the loc of button "Start"

```

Verwenden Sie den Befehl **click**, um die Aktion eines Klicks zu simulieren, anstatt beispielsweise eine mouseDown- oder mouseUp-Nachricht zu senden, um eine Grafik oder ein Bild mit einem Handler zu erstellen.

Parameter:

Die Maus-Tastennummer ist die Nummer einer Maustaste:

1 ist die Maustaste auf Mac OS-Systemen und die linke Taste auf Windows und Unix-Systemen.

 2 ist der mittlere Knopf auf Unix-Systemen.

 3 ist die rechte Maustaste auf Windows- und Unix-Systemen oder Control-Klick auf Mac OS-Systemen.

Wenn Sie keine mouseButtonNumber angeben, wird die Schaltfläche 1 verwendet.

Der Punkt ist ein Ausdruck, der zu einem Punkt, einem vertikalen und horizontalen Abstand von der oberen linken Ecke des aktuellen Stapels, getrennt durch ein Komma, auswertet.

Der Schlüssel ist einer von commandKey, controlKey, optionKey oder shiftKey. Sie können bis zu drei Schlüssel angeben, die durch Kommata getrennt sind. (Unter Windows und Unix gibt commandKey den Steuerschlüssel an.)

Der **click**-Befehl sendet eine mouseDown- und mouseUp-Nachricht an das angeklickte Objekt. Wenn zwei Objekte den angeklickten Speicherort belegen, wobei sich der eine überlappt, werden die Nachrichten an das oberste Objekt gesendet.

Wenn das Objekt unter dem Punkt eine Schaltfläche ist, deren autoHilite wahr ist, bewirkt der Befehl **click**, dass die Schaltfläche hervorgehoben und hervorgehoben wird, so als ob der Benutzer geklickt hätte.

Wenn sich der Punkt nicht in einem der Anwendungsfenster befindet, hat der Befehl **click** keine Auswirkung. Dies bedeutet, dass Sie den Befehl **click** nicht verwenden können, um zu einer anderen Anwendung zu wechseln.
AdResizeStart

Sent whan an ad is about to resize.Syntax:

```
adResizeStart <adName>

```

Examples:

```
on adResizeStart pAdName
   send "layout" to group "content"
end adResizeStart

```

Handle the **adResizeStart** message if you want to perform an action when
an ad is about to resize.

The **adResizeStart** messge is sent to the current card when an ad is
about to resize.

Parameters:

* adName: The name of ad that has been expanded (as specified in mobileAdCreate)

See also: mobileAdDelete (command),adLoaded (message),adLoadFailed (message),adResizeEnd (message),
BrowserClosing

Sent when a browser instance is closingSyntax:

```
XBrowser_Closing <instanceId>

```

Examples:

```
on browserClosing pInstanceId
  delete line (lineOffset(pInstanceId, sInstances)) of sInstances
end browserClosing

```

The **browserClosing** message is sent to the current card of a stack
containing a browser object when the browser object is about to close.

For general information on using the browser library, see the
notes in the revBrowserOpen function reference.

Parameters:

* instanceId: The integer identifier of the browser object about to close ]]\*Note:\* Forgeneral information on using the browser library, see the notes in therevBrowserOpen function reference.
Annuity

Computes the value of an annuity given an interest rate and a number of payments, this is also called ordinary annuity. Syntax:

```
annuity(<interestRate>, <numberOfPeriods>)

```

Examples:

```
put annuity(.08,10)

```

```
put annuity(currentAnnualRate/12,monthsOfLoan)

```

Use the **annuity** function to calculate the present or future value of
an annuity or to calculate loan payments.

The formula for the value of an ordinary annuity is

```
(1 - (1 + interestRate)^(- numberOfPeriods))/ interestRate

```

The **annuity** function calculates this value.

The *numberOfPeriods* and the *interestRate* must use the same unit of
time. For example, if the periods are months, the interest rate is the
interest per month.

You can use the **annuity** function to calculate the amount of loan
payments as follows:

```
paymentAmount = totalAmount/annuity(rate,periods)

```

For example, if the loan is for $2500 at an interest rate of 2% per
month and is to be repaid in a year, the monthly payment is
2500/annuity(.02,12) or $236.40.

For example, if an ordinary annuity pays $50,000 per year for five years and the interest rate is 7%, the present value would be: Present Value = $50,000 x ((1 - (1 + 0.07) ^ -5) / 0.05) = $205,010.

```
put 50000 * annuity(0.07,5) # it returns 205010

```

Parameters:

* *interestRate*: A positive number. The interestRate is expressed as a fraction of 1 so,for example, an 8% rate is written .08.
* *numberOfPeriods*: A positive number.
* Returns: The **annuity** function returns a positive number.

See also: value (function),
Codepoint

Designates the integer identifier(s) associated with a Unicode character.

Examples

```
put "Hello world" into tString
put codepoint 1 of tString -- returns "H"

```

Use the codepoint keyword to refer to the integer identifier(s) associated with Unicode character. Some character

A codepoint is an integer identifier associated with a Unicode character. A single character is composed of one or more codepoints.

The hierarchy of the new and altered chunk types is as follows:

```
byte w of codeunit x of codepoint y of char z of word ...

```

Note: This chunk type is not of general utility.
CenterRect

Specifies a region of pixels that should be stretched when the image is stretched.Syntax:

```
get the [effective] centerRect[angle] of <image>

```

Examples:

```
set the centerRect of image "buttonImage" to 20,20,45,200

```

Use to centerRect property to specifies a region of pixels that should
be stretched when the image is stretched.

If empty, then the property has no effect.

If the centerRect is set to a rectangle, then it is interpreted as
relative to the source image rect (i.e. 0, 0, the formattedWidth of
image, the formattedHeight of image) and it specifies a region of pixels
that should be stretched when the image is stretched. In particular, the
centerRect is stretched in both x and y directions, the corners outside
of the centerRect are not stretched and the sides are stretched
horizontally or vertically only depending on orientation.

The centerRect is useful for images being used as backgrounds to buttons
as it allows a single image to be used to specify the borders and center
stretching area.

Parameters:

* image: A reference or expression that evaluate to an image reference.
* rect: Empty or a comma delimited list of 4 integers representing theleft,top,right,bottom of the rectangle being specified. By default, thecenterRect property is empty.
* Value: The **centerRect** property return a comma delimited list of integersrepresenting the top, left, right and bottom of the centerRect. Bydefault, the **centerRect** property of an image is empty.
BackspaceKey

Sent to the active (focused) control(glossary), or to the current card if no control is focused.Syntax:

```
backspaceKey

```

Examples:

```
on backspaceKey -- in the script of a field
-- clear the whole field instead of removing one character:
  put empty into me
end backspaceKey

```

Handle the **backspaceKey** message if you want to do something special
when the user presses the Backspace key.

The Backspace key is not the same as the Forward Delete key. On some
keyboards, the Backspace key is labeled "Delete".

See also: cutKey (message),deleteKey (message),
CipherNames

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

```
put the cipherNames into tCypherNameList

```

Some ciphers like blowfish accept key lengths up to 448 bits where 128
is the default, others have fixed sized key lengths.

```
The **cipherNames** function is part of the

```

SSL & Encryption library. To ensure that the function works in a
standalone application, you must include this
custom library when you create your
standalone. In the Inclusions pane of the
Standalone Application Settings window, make sure the
"SSL & Encryption"
library checkbox is checked.

See also: SSL & Encryption library (library),
Close driver

Closes a device driver that was opened with the open driver command.

Syntax:

```
close driver deviceName

```

Examples:

```
close driver (line 2 of the driverNames)

```

```
close driver "USBCam1"

```

Use the **close driver** command after you're finished communicating with a peripheral device.

The **deviceName** is the name of a device driver that's installed on the system and that you have previously opened with the open driver command.

Any device drivers you have opened are closed automatically when you quit the application.

If you try to close a driver that is not already open, the result function is set to "file is not open".
BrowserDocumentFailedFrame

Sent when a browser object has encountered an error when loading a url in a frameSyntax:

```
browserDocumentFailedFrame <instanceId>, <url>, <errorMessage>

```

Examples:

```
on browserDocumentFailedFrame pInstanceId, pUrl, pErrorMessage
  answer "Failed to load frame URL" && quote \
        & pUrl & quote & return & "Error message: " && pErrorMessage
end browserDocumentFailedFrame

```

The **browserDocumentFailedFrame** message is sent to the current card of
a stack containing a browser object when the browser object has
encountered an error while loading a url and all its dependent resources
in a frame.

If the target is the main frame of the browser then the
browserDocumentFailed message message is sent instead.

For general information on using the browser library, see the
notes in the revBrowserOpen function reference.

Parameters:

* instanceId: The integer identifer of the browser object
* url: The url that has failed to load in a frame
* errorMessage: A message explaining why the url failed to load in the frame ]]\*Note:\*For general information on using the browser library, see the notes inthe revBrowserOpen function reference.

See also: revBrowserOpen function (function),browserDownloadRequest (message),browserDocumentFailed message (message),
BrowserOver

Sent when the mouse moves over a named html element in a browserSyntax:

```
XBrowser_Over <elementId>, <instanceId>

```

Examples:

```
on browserOver pInstanceId, pElementId
  set the text of field "ElementId" of me to pElementId
end browserOver

```

The **browserOver** message is sent to the current card of a stack
containing a browser object when the mouse is moved over an html element
with an "id" attribute in the browser.

The **browserOver** message is only sent if advanced browser
messages are turned on. To turn on advanced browser messages use the
following command:

revBrowserSet <instanceId>, "messages", "true"

The **browserOver** message is supported on Windows and OS X
systems later than 10.4. On older OS X systems the message is not sent
due to lack of system support from the underlying browser object.

The id of an html element is the element's "id" attribute. For example
<div id="navbar">. As this attribute is optional in most cases,
not all html elements will have an id. If the html element that the
mouse is over does not have an id, then the elementId parameter will
be empty.

For general information on using the browser library, see the
notes in the revBrowserOpen function reference.

Parameters:

* instanceId: The integer identifier of a brower object
* elementId: The id of the html element that the mouse is moving over ]]\*Note:\* ThebrowserOver message is only sent if advanced browser messages are turnedon. To turn on advanced browser messages use the following command:revBrowserSet instanceId, "messages", "true" ]]\*Note:\* The browserOvermessage is supported on Windows and OS X systems later than 10.4. Onolder OS X systems the message is not sent due to lack of system supportfrom the underlying browser object.The id of an html element is theelement's "id" attribute. For example div id="navbar". As thisattribute is optional in most cases, not all html elements will have anid. If the html element that the mouse is over does not have an id, thenthe elementId parameter will be empty. ]]\*Note:\* For general informationon using the browser library, see the notes in the revBrowserOpenfunction reference.

See also: revBrowserOpen function (function),browserClick (message),browserOut (message),
ByteToNum

Returns the numeric value of a byte.Syntax:

```
byteToNum(<byte>)

```

Examples:

```
byteToNum(byte 1 of tString)

```

```
if byteToNum(nextByte) = 0 then next repeat

```

```
numToByte(byteToNum("Z")) -- returns Z

```

Converts a single byte to a numeric value in the range 0-255

The **byteToNum** function is the inverse of the numToByte function.

Parameters:

* byte: Any expression that evaluates to a byte. If you specify a stringcontaining more than one byte, all bytes but the first are ignored.
* Returns: The **byteToNum** function returns an integer between zero and 255.

See also: charToNum (function),numToByte (function),numToChar (function),
Ms. Nakao

* Cured
* Sick

**Ms. Nakao** (中尾さん *Nakao-san*) is the first person who was healed by Hiro Shishigami. She is working in an office. Her mother is her only relative and she is already quite old and in a hospital. Nakao was suffering from cancer and was expecting to die soon.

## Appearance

Nakao has green eyes and a mole beneath her nose. Her hair is long and black. She is actually quite pretty, but while she was suffering from cancer, she looked very gaunt and had bags under her eyes.

## Plot

Nakao boss wanted to have lunch with her, but she only ate a sandwich and took her pain killers. She explained to him that her cancer was too far, but she didn't tell anyone yet. He is sorry and offers her his help. When she later catches a train, she almost considers jumping in front of it but then stops at the last second. Later on a bench she cried out, that she wanted to live. Some children laughed at her and insulted Nakao.

That is when she saw Hiro Shishigami's message about ill people meeting him where she though it was surely a cruel joke, but she decided to try it as a last chance. She almost gave up hope but then he came and told her to spread it on the internet, if she was cured. Nakao let herself be examined again and was truly cured again. She posted how happy and thankful she was and greeted her boss with a smile at work.

## Etymology

* The surname **Nakao** means "middle" (中) (**naka**) and "tail" (尾) (**o**).
BitAnd

Performs a "bitwise and" operation on the binary representation of two numbers.Syntax:

```
<number1> bitAnd <number2>

```

Examples:

```
0 bitAnd 1 -- evaluates to 0

```

```
3 bitAnd 2 -- in binary: 11 bitAnd 10; evaluates to 10; converted to 2

```

Use the **bitAnd** operator to operate directly on the bits of two
numbers.

To perform the **bitAnd** operation, LiveCode first converts both
operands to their binary equivalent, a string of ones and
zeroes. 1 is equivalent to true, and 0 is equivalent to false.

For each bit of number1, LiveCode performs an and operation with
the corresponding bit of number2 to produce a result. A bit is 1
if the corresponding bits of number1 and number2 are both 1.
Otherwise, the bit is 0.

Finally, the binary number thus created is converted back to decimal.

Parameters:

* number1: The number1 and number2 are numbers, or expressions that evaluate tonumbers, between zero and 4,294,967,295 (2^32 - 1).
* number2:
* Description:Use the **bitAnd** operator to operate directly on the bits of twonumbers.

See also: and (operator),bitNot (operator),
CommandKey

Returns the state of the Command key.Syntax:

```
commandKey()

```

Examples:

```
put commandKey() after keyHistory

```

```
if the commandKey is down then edit script of me

```

Use the **commandKey** function(control structure) to check whether the
Command key is being pressed.

On Unix and Windows systems, the **commandKey** function returns
the same value as the controlKey function(control structure): the
two functions are synonyms.

See also: controlKey (function),value (function),keysDown (function),commandKeyDown (message),
CopyResource

Copies a resource from one Mac OS file to another.Syntax:

```
copyResource(<file>, <destinationFile>, <resType>,{<resID> | <resName>}[, <newID>])

```

Examples:

```
get copyResource("Template","New Build","vers",1,1)

```

```
put copyResource(theFile,anotherFile,"XCMD","SetPort") into trashVar

```

```
get copyResource(field "Source",currentFile,nextResource,200)

```

Use the **copyResource** function to copy resources (such as
icons, externals, and version resources) from one file to
another.

If you don't specify a newID, the new resource has the same ID as
the original resource. Specifying a newID does not change the
resource ID of the original resource in the file; it only affects
the copy in the destinationFile.

Parameters:

* file: The name and location of the file containing the resource. If youspecify a name but not a location, LiveCode assumes the file is in thedefaultFolder.
* destinationFile: The name and location of the file you want to copy the resource to.
* resType: The 4-character type of the resource you want to move.
* resID (integer): An integer that specifies the resource ID of the resource you want tocopy.
* resName: The name of the resource you want to copy.
* newID (integer): An integer that specifies the resource ID for the newly-copied resource.
* Returns: The **copyResource** function always returns empty.
* The result: If the file does not exist, the result is set to "can't find file".If the destinationFile does not exist, the **copyResource** functioncreates the file, but the result is set to"can't create resource fork for destination file". If thedestinationFile exists but has no resource fork. the **copyResourcefunction** creates the resource fork and copies the resource to it. Ifthe destinationFile is open, the result is set to"Can't open resource fork".

See also: result (function),setResource (function),
BottomLeft

Specifies the location of the specified object's lower left corner.Syntax:

```
set the bottomLeft of <object> to <left>, <bottom>

```

Examples:

```
set the bottomLeft of this stack to 400,250

```

```
set the bottomLeft of button myButton to 100,the bottom of button 1

```

Use the **bottomLeft** property to change the placement of a control
or window.

The **bottomLeft** of a stack is in absolute (screen) coordinates. The first item (the left) of a card's
**bottomLeft** property is always zero; the second item (the bottom)
is always the height of the stack window. The **bottomLeft** of a group
or control is in relative (window) coordinates.

In window coordinates, the point 0,0 is at the top left of the stack
window. In screen coordinates, the point 0,0 is at the top left of the
screen.

Changing the **bottomLeft** of an object moves it to the new
position without resizing it. To change an object's size, set
its height, width, or rectangle properties.

The order of the bottom and left parameters is reversed compared to the property name:
left comes first, then bottom.

See also: card (object), topRight (property), left (property), pixels (property), height (property), width (property), bottom (property), properties (property),
AppleEvent

the current card whenever the application receives an Apple event.Syntax:

```
appleEvent <class>, <ID>, <sender>

```

Examples:

```
on appleEvent theClass,theID
-- execute a set of statements in a text file
  if theClass is "misc" and theID is "dosc" then
    request appleEvent data -- get the content of the AppleEvent
    do URL ("file:" & it)
  end if
  pass appleEvent
end appleEvent

```

Handle the **appleEvent** message to respond to a custom Apple event,
or one that you want to handle specially.

Use the request appleEvent command to obtain the data associated with
an Apple event.

For more information about Apple events, see Apple Computer's technical
documentation, Inside Macintosh: Interapplication Communication, located
at http://developer.apple.com/documentation/mac/IAC/IAC-2.html.

Parameters:

* class: The class and ID together identify the exact Apple event that wasreceived.The class parameter is the event class: possible classesinclude aevt (for required Apple Events such as "open document" and"print" ), misc (for miscellaneous events such as "do script" ), andothers.
* ID: The ID parameter is the name of the specific Apple event.
* sender: The sender parameter is the address of the process that sent the Appleevent.
BorderWidth

Specifies the width of an object's border.Syntax:

```
set the borderWidth of <line> of <field> to <pixelWidth>

```

Examples:

```
set the borderWidth of button "Cancel" to 1

```

```
set the borderWidth of this card to 24

```

```
set the borderWidth of line 5 of field 1 to 10

```

Use the **borderWidth** property to change the appearance of an
object's border.

By default, the **borderWidth** of newly created objects is 2.
By default, the **borderWidth** of a paragraph of text in a field is 0.

If the object's showBorder property is false, the **borderWidth**
property has no effect.

The border's appearance and color is affected by the setting of the
object's threeD property.

Parameters:

* pixelWidth (integer): An integer between zero and 255.

See also: borderPattern (property),
Close file

Closes a file that was opened with the open file command.

Syntax:

```
close file filePath

```

Examples:

```
close file "/Desktop/Temp"

```

```
close file line 1 of the openFiles

```

```
open file (specialFolderPath("desktop") & "/text.txt")
write "This is a test" to file (specialFolderPath("desktop") & "/text.txt")
close file (specialFolderPath("desktop") & "/text.txt")

```

Use the **close file** command to release a file after reading from it or writing to it. (A file that is open for writing can't be used by any other application until you've closed the file.)

The *filePath* is the name and location of the file you want to close. If you specify a name but not a location, LiveCode assumes the file is in the defaultFolder.

Any files you have opened are closed automatically when you quit the application.

If you try to close a file that is not already open, the result function is set to "file is not open".

See Also: openFiles Function, sysError Function, delete file Command, open file Command, read from file Command, write to file Command, seek Command, close Command, close driver Command, serialControlString Property, COMn: Keyword, modem: Keyword, file Keyword, LPT1: Keyword, printer: Keyword
CustomPropertySets

Lists all the custom property sets that can apply to an object(glossary).Syntax:

```
get the customPropertySets of <object>

```

Examples:

```
if it is among the lines of the customPropertySets of me then doItOver

```

Use the **customPropertySets** property to find out what property sets
are defined for an object(glossary).

You can delete an object's custom property sets by setting the object's
**customPropertySets** to empty.

See also: setProp (control structure),customPropertySet (property),revProfile (property),customKeys (property),
BrowserDocumentComplete

Sent when a browser object has finished loading a urlSyntax:

```
XBrowser_DocumentComplete <url>, <instanceId>

```

Examples:

```
on browserDocumentComplete pInstanceId, pUrl
  enable button "Go"
end browserDocumentComplete

```

The **browserDocumentComplete** message is sent to the current card of a
stack containing a browser object when the browser object has finished
loading a url and all its dependent resources.

If the target is the main frame of the browser (e.g. the html page with
the "FRAMESET" declaration), then the **browserDocumentComplete** message
is sent. Otherwise the browserDocumentCompleteFrame message is sent
instead.

For general information on using the browser library, see the
notes in the revBrowserOpen function reference.

Parameters:

* instanceId: The integer identifer of the browser object ]]\*Note:\* For generalinformation on using the browser library, see the notes in therevBrowserOpen function reference.
* url: The url that has finished loading

See also: browserDownloadRequest (message),browserDocumentCompleteFrame message (message),
Answer page setup

Displays the appropriate page setup dialog for the platform.

Syntax:

```
answer page setup [as sheet]

```

 Datei:LCAnswerPageSetup.jpg
Examples:

```
answer page setup

```

```
if the commandKey is down then
  answer page setup
end if

```

The answer page setup command displays a dialog box where the user can set certain printing page related properties.

If the systemPrintSelector property is false or the system does not support native print dialogs a stack named "Page Setup Dialog" will be used. If the systemPrintSelector property is true then a dialog will be displayed by the operating system, in this case the exact options are determined by the printer driver and the operating system.

If the user does not cancel the dialog, upon return the printer settings properties will be updated to reflect their choices.

Note: If the user clicks the cancel button of the answer page setup dialog, then "cancel" is put into the result

See Also: answer printer, answer, open printing, printMargins Property, printRotated Property, revShowPrintDialog, reset printing, print
Bottom

Specifies how far an object's bottom edge is from the top of the window or screen.Syntax:

```
set the bottom of <object> to <number>

```

Examples:

```
if the bottom of this stack > 600 then changeStackPlacement

```

```
set the bottom of card field 1 to the height of this stack

```

Use the **bottom** property to change the vertical placement of a
control or window.

The **bottom** of a stack is in [[absolute (screen)
coordinates(glossary)]]. The **bottom** of a card is always equal to the
height of the stack window; setting the **bottom** of a card does not
cause a script error, but it has no effect. The **bottom** of a
group or control is in relative (window) coordinates(glossary).

Changing the **bottom** of an object(glossary) shifts it to the new
position without resizing it. To change an object's height, set
its height or rectangle property.

The height property of an object(glossary) is equal to its
**bottom** minus its top.

See also: stack (object),pixels (property),rectangle (property),bottomMargin (property),bottomRight (property),bottomLeft (property),height (property),top (property),
CurrentTime

Specifies the elapsed time in a movie or sound.Syntax:

```
set the currentTime of <player> to <number>

```

Examples:

```
set the currentTime of player "Open Door" to 300

```

Use the **currentTime** property during playing to find out the progress
of the movie or sound, or to skip ahead or back.

The **currentTime** is the number of the interval where the current
position is.

The number of intervals per second is specified by the player's
timeScale property. The total number of intervals is given in the
player's duration property.

See also: playPaused (message),playStarted (message),player (object),currentFrame (property),callbacks (property),duration (property),