Adobe 65036570 User Guide - Page 293

Setting behavior properties with script, Customizing a behavior's property

Page 293 highlights

ADOBE DIRECTOR 11.0 282 User Guide To allow users to set different values for a property in different instances of the behavior, the behavior's script must have the following: • A property statement (Lingo) or a var statement (JavaScript syntax) that allows each instance to maintain a separate value for the property • An on getPropertyDescriptionList handler that sets up the property or variable. Setting behavior properties with script Behaviors usually have properties for which each instance of the behavior maintains its own values. (An instance is the unique instance of the behavior assigned to sprites or frames.) These properties are shared among handlers in a behavior's script the same way that properties are shared among handlers in an object. • Put the property or var statement at the beginning of the behavior's script. A property or var statement starts with the word property or var followed by the names of the individual properties or variables. For example, the statement property movement declares that movement is a property of the behavior. Customizing a behavior's property If a behavior's script includes an on getPropertyDescriptionList handler, Director lets users set the property's initial values from the Parameters dialog box. The behavior's Parameters dialog box opens in three circumstances: • After the user drags a behavior to a sprite or frame • When the user double-clicks the behavior in the Behavior inspector dialog box • When the user clicks the Parameters button in the Behavior inspector The on getPropertyDescriptionList handler generates a property list that specifies these attributes of the property or variable: • The default initial value • The type of data the property or variable contains, such as Boolean, integer, string, cast member, or a specific type of cast member • A comment in the Parameters dialog box to describe what the user is setting The definition of a behavior's property or variable must include the property's or variable's name, default value, and data type and the descriptive string that appears in the Parameters dialog box. The definition can also include an optional specification for the range of values allowed for the property or variable. The name of the property or variable comes first in the definition. The remainder of the definition is a property list that assigns a value to each of the property's or variable's attributes. For example, to define the property movement as an integer that can be set to a value from 1 to 10 and whose default value is 5, use a phrase similar to the one that follows: #movement: [#default: 5, #format:#integer, #comment: "Set motion to the right:", #range: [#min:1, #max:10]]

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336
  • 337
  • 338
  • 339
  • 340
  • 341
  • 342
  • 343
  • 344
  • 345
  • 346
  • 347
  • 348
  • 349
  • 350
  • 351
  • 352
  • 353
  • 354
  • 355
  • 356
  • 357
  • 358
  • 359
  • 360
  • 361
  • 362
  • 363
  • 364
  • 365
  • 366
  • 367
  • 368
  • 369
  • 370
  • 371
  • 372
  • 373
  • 374
  • 375
  • 376
  • 377
  • 378
  • 379
  • 380
  • 381
  • 382
  • 383
  • 384
  • 385
  • 386
  • 387
  • 388
  • 389
  • 390
  • 391
  • 392
  • 393
  • 394
  • 395
  • 396
  • 397
  • 398
  • 399
  • 400
  • 401
  • 402
  • 403
  • 404
  • 405
  • 406
  • 407
  • 408
  • 409
  • 410
  • 411
  • 412
  • 413
  • 414
  • 415
  • 416
  • 417
  • 418
  • 419
  • 420
  • 421
  • 422
  • 423
  • 424
  • 425
  • 426
  • 427
  • 428
  • 429
  • 430
  • 431
  • 432
  • 433
  • 434
  • 435
  • 436
  • 437
  • 438
  • 439
  • 440
  • 441
  • 442
  • 443
  • 444
  • 445
  • 446
  • 447
  • 448
  • 449
  • 450
  • 451
  • 452
  • 453
  • 454
  • 455
  • 456
  • 457
  • 458
  • 459
  • 460
  • 461
  • 462
  • 463
  • 464
  • 465
  • 466
  • 467
  • 468
  • 469
  • 470
  • 471
  • 472
  • 473
  • 474
  • 475
  • 476
  • 477
  • 478
  • 479
  • 480
  • 481
  • 482
  • 483
  • 484
  • 485
  • 486
  • 487
  • 488
  • 489
  • 490
  • 491
  • 492
  • 493
  • 494
  • 495
  • 496
  • 497
  • 498

ADOBE DIRECTOR 11.0
User Guide
282
To allow users to set different values for a property in different instances of the behavior, the behavior’s script must
have the following:
A
property
statement (Lingo) or a
var
statement (JavaScript syntax) that allows each instance to maintain a
separate value for the property
An
on getPropertyDescriptionList
handler that sets up the property or variable.
Setting behavior properties with script
Behaviors usually have properties for which each instance of the behavior maintains its own values. (An instance is
the unique instance of the behavior assigned to sprites or frames.) These properties are shared among handlers in a
behavior’s script the same way that properties are shared among handlers in an object.
Put the
property
or
var
statement at the beginning of the behavior’s script.
A
property
or
var
statement starts with the word
property
or
var
followed by the names of the individual
properties or variables. For example, the statement
property movement
declares that
movement
is a property of the
behavior.
Customizing a behavior’s property
If a behavior’s script includes an
on getPropertyDescriptionList
handler, Director lets users set the property’s
initial values from the Parameters dialog box. The behavior’s Parameters dialog box opens in three circumstances:
After the user drags a behavior to a sprite or frame
When the user double-clicks the behavior in the Behavior inspector dialog box
When the user clicks the Parameters button in the Behavior inspector
The
on getPropertyDescriptionList
handler generates a property list that specifies these attributes of the
property or variable:
The default initial value
The type of data the property or variable contains, such as Boolean, integer, string, cast member, or a specific
type of cast member
A comment in the Parameters dialog box to describe what the user is setting
The definition of a behavior’s property or variable must include the property’s or variable’s name, default value, and
data type and the descriptive string that appears in the Parameters dialog box. The definition can also include an
optional specification for the range of values allowed for the property or variable.
The name of the property or variable comes first in the definition. The remainder of the definition is a property list
that assigns a value to each of the property’s or variable’s attributes.
For example, to define the property
movement
as an integer that can be set to a value from 1 to 10 and whose default
value is 5, use a phrase similar to the one that follows:
#movement: [#default: 5, #format:#integer,
#comment: "Set motion to the right:", #range: [#min:1, #max:10]]