margin

Syntax

member(whichCastMember).margin
the margin of member whichCastMember
Description

Field cast member property; determines the size, in pixels, of the margin inside the field box.

Example

The following statement sets the margin inside the box for the field cast member Today's News to 15 pixels:

member("Today's News").margin = 15

mapMemberToStage()

Syntax

sprite(whichSpriteNumber). mapMemberToStage(whichPointInMember)
mapMemberToStage(sprite whichSpriteNumber, whichPointInMember)
Description

Function; uses the specified sprite and point to return an equivalent point inside the dimensions of the Stage. This properly accounts for the current transformations to the sprite using quad, or the rectangle if not transformed.

This is useful for determining if a particular area of a cast member has been clicked, even if there have been major transformations to the sprite on the Stage.

If the specified point on the Stage is not within the sprite, a VOID is returned.

See also

map(), mapStageToMember()

machineType

Description

This property is obsolete. Use platform instead

loopStartTime

Syntax

sound(channelNum).queue([#member: member(whichmember), {#startTime: milliseconds, #endTime: milliseconds, #loopStartTime: milliseconds, #loopEndTime: milliseconds, #loopCount: numberOfLoops, #preloadTime: milliseconds, #rateShift: shiftAmount}])
sound(channelNum).loopStartTime
Description

Cast member property; the start time, in milliseconds, of the loop for the current sound being played by soundObject. Its value is a floating-point number, allowing you to measure and control sound playback to fractions of a millisecond. The default is the startTime of the sound if no loop has been defined.

This property can only be set when passed as a property in a queue(), play(), or setPlaylist() command.

Example

This handler queues and plays two sounds. The first sound, cast member Chimes, is played in its entirety. The second sound, cast member introMusic, is played starting at its 3-second point, with a loop repeated 5 times from the 8-second point to the 8.9 second point, and stopping at the 10-second point. 4 seconds of the sound will be preloaded and it will be played back with a rateShift of 1, or at one half-step higher pitch than normal.

on playMusic
    sound(2).queue([#member: member("Chimes")])
    sound(2).queue([#member: member("introMusic"), #startTime: 3000,\
    #endTime: 10000, #loopStartTime: 8000, #loopEndTime: 8900, #loopCount: 5, \
    #preloadTime: 4000, #rateShift: 1])
    sound(2).play()
end
Example

This handler plays sound cast member introMusic in sound channel 2. Playback loops five times between two points 8 seconds and 8.9 seconds into the sound.

on playMusic
    sound(2).play([#member:member("introMusic"), #startTime:3000,\
    #loopCount:5,#loopStartTime:8000, #loopEndTime:8900])
end
Example

This handler causes the text field TimWords to read "Help me, I'm stuck!" when the currentTime of sound channel 2 is between its loopStartTime and loopEndTime:

on idle
    if sound(2).currentTime > sound(2).loopStartTime and \
    sound(2).currentTime < sound(2).loopEndTime then
        member("TimWords").text = "Help me, I'm stuck!"
    else
        member("TimWords").text = "What's this sticky stuff?"
    end if
end
See also

breakLoop(), setPlaylist(), loopCount, loopEndTime, loopsRemaining, queue(), play() (sound), stop() (sound), getPlaylist()

applicationName

Syntax

the applicationName
Description

Global property; indicates the file name of the projector or the Director authoring application.

Example

This statement displays in a field the file name of the projector that is playing:

member("field").text = the applicationName
See also

environment, productVersion

clickMode

Syntax

sprite(whichFlashSprite).clickMode
the clickMode of sprite whichFlashSprite
member(whichFlashMember).clickMode
the clickMode of member whichFlashMember
Description

Flash cast member and sprite property; controls when the Flash movie sprite detects mouse click events (mouseUp and mouseDown) and when it detects rollovers (mouseEnter, mouseWithin, and mouseLeave). The clickMode property can have these values:

#boundingBox—Detects mouse click events anywhere within the sprite's bounding rectangle and detects rollovers at the sprite's boundaries.

#opaque (default)—Detects mouse click events only when the pointer is over an opaque portion of the sprite and detects rollovers at the boundaries of the opaque portions of the sprite if the sprite's ink effect is set to Background Transparent. If the sprite's ink effect is not set to Background Transparent, this setting has the same effect as #boundingBox.

#object—Detects mouse click events when the mouse pointer is over any filled (nonbackground) area of the sprite and detects rollovers at the boundaries of any filled area. This setting works regardless of the sprite's ink effect.



This property can be tested and set.

Example

This script checks to see if the sprite, which is specified with an ink effect of Background Transparent, is currently set to be rendered direct to Stage. If the sprite is not rendered direct to Stage, the sprite's clickMode is set to #opaque. Otherwise (because ink effects are ignored for Flash movie sprites that are rendered direct to Stage), the sprite's clickMode is set to #boundingBox.

Dot syntax:

on beginSprite me
    if sprite(the spriteNum of me).directToStage = FALSE then
        sprite(the spriteNum of me).clickMode = #opaque
    else
        sprite(the spriteNum of me).clickMode = #boundingBox
    end if
end
Verbose syntax:

on beginSprite me
    if the directToStage of sprite the spriteNum of me = FALSE then
        set the clickMode of sprite the spriteNum of me = #opaque
    else
        set the clickMode of sprite the spriteNum of me = #boundingBox
    end if
end

closed

Syntax

member(whichCastMember).closed
Description

Vector shape cast member property; indicates whether the end points of a path are closed or open.

Vector shapes must be closed in order to contain a fill.

The value can be:

TRUE—the end points are closed.

FALSE—the end points are open.