Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.

Commit fc91ec3

Browse files
livecodealilivecodeali
committed
[[ Docs ]] Fix up all message entries
- Ensure all params are in the pParamName format - Fix various formatting issues - Audit associations
1 parent 84209ba commit fc91ec3

File tree

140 files changed

+543
-789
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+543
-789
lines changed

‎docs/dictionary/message/IDChanged.lcdoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Name: IDChanged
22

33
Type: message
44

5-
Syntax: IDChanged <oldID>, <newID>
5+
Syntax: IDChanged <pOldID>, <pNewID>
66

77
Summary:
88
Sent to an <image> when its <ID> <property> is changed.
@@ -22,10 +22,10 @@ on IDChanged prevID,currentID -- update ID stored in another object
2222
end IDChanged
2323

2424
Parameters:
25-
oldID:
25+
pOldID:
2626
The image's original ID number.
2727

28-
newID:
28+
pNewID:
2929
The image's new ID number.
3030

3131
Description:

‎docs/dictionary/message/QTDebugStr.lcdoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Name: qtDebugStr
22

33
Type: message
44

5-
Syntax: qtDebugStr <string>
5+
Syntax: qtDebugStr <pString>
66

77
Summary:
88
Sent to a <player> containing a <QuickTime> movie when the movie
@@ -22,7 +22,7 @@ on qtDebugStr myMessage
2222
end qtDebugStr
2323

2424
Parameters:
25-
string (string):
25+
pString (string):
2626
The QuickTime parameter the movie passed to LiveCode when it performed
2727
the "DebugStr" action.
2828

‎docs/dictionary/message/accelerationChanged.lcdoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Name: accelerationChanged
22

33
Type: message
44

5-
Syntax: accelerationChanged <x>, <y>, <z>
5+
Syntax: accelerationChanged <pXAccel>, <pYAccel>, <pZAccel>
66

77
Summary:
88
Sent to the current card of the defaultStack at the interval specified
@@ -21,13 +21,13 @@ on accelerationChanged pXAccel, pYAccel, pZAccel
2121
end accelerationChanged
2222

2323
Parameters:
24-
x:
24+
pXAccel:
2525
the acceleration along the x axis relative to gravity
2626

27-
y:
27+
pYAccel:
2828
the acceleration along the y axis relative to gravity
2929

30-
z:
30+
pZAccel:
3131
the acceleration along the z axis relative to gravity
3232

3333
Description:

‎docs/dictionary/message/adClicked.lcdoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@ Name: adClicked
22

33
Type: message
44

5-
Syntax: adClicked <adName>
5+
Syntax: adClicked <pAdName>
66

77
Summary:
88
Sent when the user clicks on an ad.
99

10-
Associations: stack
11-
1210
Introduced: 5.5
1311

1412
OS: ios, android
@@ -21,14 +19,14 @@ on adClicked pAdName
2119
end adClicked
2220

2321
Parameters:
24-
adName:
25-
The name of ad that has been clicked (as specified in mobileAdCreate)
22+
pAdName:
23+
The name of ad that has been clicked (as specified in <mobileAdCreate>)
2624

2725
Description:
2826
Handle the <adClicked> message if you want to perform an action when a
2927
user clicks on an ad.
3028

31-
The <adClicked> messge is sent to the object that created the ad when
29+
The <adClicked> message is sent to the object that created the ad when
3230
the user clicks on ad.
3331

3432
References: mobileAdCreate (command), mobileAdDelete (command),

‎docs/dictionary/message/adExpandEnd.lcdoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@ Name: adExpandEnd
22

33
Type: message
44

5-
Syntax: adExpandEnd <adName>
5+
Syntax: adExpandEnd <pAdName>
66

77
Summary:
88
Sent whan an ad has finished expanding.
99

10-
Associations: stack
11-
1210
Introduced: 6.0
1311

1412
OS: ios, android
@@ -21,14 +19,14 @@ on adExpandEnd pAdName
2119
end adExpandEnd
2220

2321
Parameters:
24-
adName:
25-
The name of ad that has been expanded (as specified in mobileAdCreate)
22+
pAdName:
23+
The name of ad that has been expanded (as specified in <mobileAdCreate>)
2624

2725
Description:
2826
Handle the <adExpandEnd> message if you want to perform an action when
2927
an ad finishes expanding.
3028

31-
The <adExpandEnd> messge is sent to the current card when an ad has
29+
The <adExpandEnd> message is sent to the current card when an ad has
3230
finished expanding.
3331

3432
References: mobileAdCreate (command), mobileAdRegister (command),

‎docs/dictionary/message/adExpandStart.lcdoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@ Name: adExpandStart
22

33
Type: message
44

5-
Syntax: adExpandStart <adName>
5+
Syntax: adExpandStart <pAdName>
66

77
Summary:
88
Sent whan an ad is about to expand.
99

10-
Associations: stack
11-
1210
Introduced: 6.0
1311

1412
OS: ios, android
@@ -21,14 +19,14 @@ on adExpandStart pAdName
2119
end adExpandStart
2220

2321
Parameters:
24-
adName:
25-
The name of ad that has been expanded (as specified in mobileAdCreate)
22+
pAdName:
23+
The name of ad that has been expanded (as specified in <mobileAdCreate>)
2624

2725
Description:
2826
Handle the <adExpandStart> message if you want to perform an action when
2927
an ad is about to expand.
3028

31-
The <adExpandStart> messge is sent to the current card when an ad is
29+
The <adExpandStart> message is sent to the current card when an ad is
3230
about to expand.
3331

3432
References: mobileAdCreate (command), mobileAdRegister (command),

‎docs/dictionary/message/adLoadFailed.lcdoc‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ Syntax: adLoadFailed <adName>
77
Summary:
88
Sent when there is an error loading an ad.
99

10-
Associations: stack
11-
1210
Introduced: 5.5
1311

1412
OS: ios, android

‎docs/dictionary/message/adLoaded.lcdoc‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@ Name: adLoaded
22

33
Type: message
44

5-
Syntax: adLoaded <adName>, <default>
5+
Syntax: adLoaded <pAdName>, <pDefault>
66

77
Summary:
88
Sent when an ad had loaded (or reloaded).
99

10-
Associations: stack
11-
1210
Introduced: 5.5
1311

1412
OS: ios, android
@@ -21,17 +19,17 @@ on adLoaded pAd
2119
end adLoaded
2220

2321
Parameters:
24-
adName:
25-
The name of ad that has loaded (as specified in mobileAdCreate)
22+
pAdName:
23+
The name of ad that has loaded (as specified in <mobileAdCreate>)
2624

27-
default (bool):
25+
pDefault (bool):
2826
True or false, specifying if the loaded ad is a default ad.
2927

3028
Description:
3129
Handle the <adLoaded> message if you want to perform an action when an
3230
ad finishes loading.
3331

34-
The <adLoaded> messge is sent to the object that created the ad when the
32+
The <adLoaded> message is sent to the object that created the ad when the
3533
ad has loaded, or reloaded.
3634

3735
References: mobileAdCreate (command), mobileAdDelete (command),

‎docs/dictionary/message/adResizeEnd.lcdoc‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@ Name: adResizeEnd
22

33
Type: message
44

5-
Syntax: adResizeEnd <adName>
5+
Syntax: adResizeEnd <pAdName>
66

77
Summary:
88
Sent whan an ad finished resizing.
99

10-
Associations: stack
11-
1210
Introduced: 6.0
1311

1412
OS: ios, android
@@ -21,8 +19,8 @@ on adResizeEnd pAdName
2119
end adResizeEnd
2220

2321
Parameters:
24-
adName:
25-
The name of ad that has been expanded (as specified in mobileAdCreate)
22+
pAdName:
23+
The name of ad that has been expanded (as specified in <mobileAdCreate>)
2624

2725
Description:
2826
Handle the <adResizeEnd> message if you want to perform an action when

‎docs/dictionary/message/adResizeStart.lcdoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@ Name: adResizeStart
22

33
Type: message
44

5-
Syntax: adResizeStart <adName>
5+
Syntax: adResizeStart <pAdName>
66

77
Summary:
88
Sent whan an ad is about to resize.
99

10-
Associations: stack
11-
1210
Introduced: 6.0
1311

1412
OS: ios, android
@@ -21,14 +19,14 @@ on adResizeStart pAdName
2119
end adResizeStart
2220

2321
Parameters:
24-
adName:
25-
The name of ad that has been expanded (as specified in mobileAdCreate)
22+
pAdName:
23+
The name of ad that has been expanded (as specified in <mobileAdCreate>)
2624

2725
Description:
2826
Handle the <adResizeStart> message if you want to perform an action when
2927
an ad is about to resize.
3028

31-
The <adResizeStart> messge is sent to the current card when an ad is
29+
The <adResizeStart> message is sent to the current card when an ad is
3230
about to resize.
3331

3432
References: mobileAdCreate (command), mobileAdRegister (command),

0 commit comments

Comments
 (0)