Symbol |
Type |
Get/Set |
Description |
Notes |
maxMember |
integer |
G |
The index of the last occupied cast member slot |
|
memberCount |
integer |
G |
The number of occupied cast member slots in the cast |
Does not include "empty" cast member slots" |
minMember |
integer |
G |
The index of the first occupied cast member slot |
|
modified |
integer |
G |
1 if the castlib been changed, 0 if not |
Set by player |
name |
string |
G/S |
Author-defined name of cast (!= filename) |
User sets in Cast Properties dialog |
pathName |
string |
G/S |
Full pathname of cast. Set allowed only for linked casts |
Setting this swaps in new linked cast on-the-fly |
preloadMode |
integer |
G/S |
Cast preload mode:
0 = none,
1 = before 1st frame,
2 = after first frame |
|
version |
integer |
G |
File version of the castlib |
|
Authoring-only |
|
|
|
|
selection |
linear list |
G/S |
List indicating current cast selection |
List of lists. Each sublist specifies a continuous range of
selected cast members, for example [[1, 5], [8, 12], [15,15]] |
Notes:
Symbol |
Type |
Get/Set |
Description |
Notes |
castLibNum |
integer |
G |
Index of cast library in the movie. |
|
castType |
symbol |
G |
Type of cast member returned as symbol. |
Using "castType", text fields are returned
as type #text (for Director 4.0 compat.) |
comments |
string |
G/S |
Comments associated with the member |
|
creationDate |
date |
G |
Date the member was created in the Director cast |
|
fileName |
string |
G/S |
Full pathname of linked cast member, only valid for linked castMems, setting changes link on-the-fly |
|
height |
integer |
G |
Height of cast member's default rectangle |
|
hilite |
integer |
G/S |
0=not hilighted, 1=highlighted |
|
linked |
integer |
G |
0=not linked, 1=linked |
|
loaded |
integer |
G/S |
0 = unloaded,
1= load. Setting to 0 unloads cast member, setting to 1 loads it |
|
media |
media |
G/S |
Media for the member |
|
mediaReady |
integer |
G |
0=media is not yet streamed 1=media is on local disk |
|
member |
castMem |
G |
CastMemRef of cast member |
|
modified |
integer |
G/S |
0 = not modified since last save,
1 = props or media modified |
|
modifiedBy |
string |
G |
Name of user who last modified the member |
|
modifiedDate |
date |
G |
Date the member was last modified |
|
name |
string |
G/S |
User-defined name of the cast member |
|
number |
integer |
G |
Integer repetition of castMemRef (high 16-bits = castLibIndex - 1) |
|
purgePriority |
integer |
G/S |
0=never,
1=last,
2=next,
3=normal |
|
rect |
rect |
G/S |
Cast member's default rectangle; set only allowed for text field |
|
regPoint |
point |
G/S |
Registration point for cast member. Currently can only set for
bitmaps, returns (0,0) for all others |
|
scriptText |
string |
G/S |
The text of the cast member script |
|
scriptSyntax |
symbol |
G |
Returns #lingo or #javascript |
|
size |
integer |
G |
Memory currently occupied by cast member (in bytes) |
|
thumbnail |
picture |
G/S |
The thumbnail image for the member |
|
type |
symbol |
G |
Type of cast member returned as symbol. |
Using "type", text fields are returned as
#field (Director 5.0 naming) |
width |
integer |
G |
Width of cast member's default rectangle |
|
Name |
Description |
#bitmap |
Static bitmap image of any pixel depth |
#filmLoop |
Looped section of Director score (mini, embedded, non-interactive
movie) |
#text |
Block of styled text |
#palette |
Color Look-Up Table (CLUT), associated with bitmap cast members |
#picture |
Macintosh PICT (metafile-like) object |
#sound |
Sound chunk (can be various sample rates/sizes, compressed,
looped, and so on) |
#button |
Simple button, created with the Director Tools palette |
#shape |
Simple shape (square, oval, or line; filled or unfilled) created
with Tools |
#movie |
Linked (external) fully-interactive Director movie |
#digitalVideo |
QuickTime or AVI movie |
#script |
Lingo script (in styled text form) |
#richText |
Block of Rich Text (new to Director 5.0; includes special formatting
information) |
#OLE |
Microsoft OLE object (new to Director 5.0) |
#transition |
Transition and associated properties (new to Director 5.0) |
In addition, other cast member types can be registered by Sprite and Transition
Xtras. These types can be obtained using the
Symbol |
Type |
Get/Set |
Description |
text |
string |
G/S |
The characters in the text field (null-terminated) |
textStyle |
string |
G/S |
The styles used in the text field; comma-delimited, combination
of: "bold", "italic", "underline",
"outline", "shadow","condense",
and "extend" |
textFont |
string |
G/S |
The font of the entire text field |
textHeight |
integer |
G/S |
The line height of every line in the text field |
textSize |
integer |
G/S |
The font size of every character in the text field |
foreColor |
integer |
G/S |
The foreground color index of every character in the text field |
backColor |
integer |
G/S |
The background color of the text field |
textAlign |
string |
G/S |
The alignment mode as a string: "left", "center",
"right" |
buttonType |
symbol |
G/S |
Style of the button as symbol: #pushButton, #checkBox,
#radioButton |
Symbol |
Type |
Get/Set |
Description |
loop |
integer |
G/S |
0=don't loop, 1=loop |
center |
integer |
G/S |
0=don't center, 1=center |
crop |
integer |
G/S |
0=scale, 1=crop |
sound |
integer |
G/S |
0=sound disabled, 1=sound enabled |
duration |
integer |
G |
Duration of movie in ticks (1/60th second) |
controller |
integer |
G/S |
0=hide controller, 1=show controller |
directToStage |
integer |
G/S |
0=composite (slower), 1=directToStage (faster) |
frameRate |
integer |
G/S |
Framerate of movie: fixed frame rate or: 0=normal playback;
-1=play every frame, normal rate;
-2=play every frame, fast as possible. |
pausedAtStart |
integer |
G/S |
0=play immediately, 1=paused at start |
video |
integer |
G/S |
0=video disabled, 1=video enabled |
preload |
integer |
G/S |
0=disable preload into RAM,
1=enable preload into RAM |
timeScale |
integer |
G |
Time scale of movie |
tracks |
integer |
G |
Track count: number of tracks in the movie |
track |
symbol |
G |
Track type of track #1: #video, #sound, #text,
#music, #timeCode |
startTime |
integer |
G |
Start time of track #1 |
stopTime |
integer |
G |
Stop time of track #1 |
digitalVideoType |
symbol |
G |
#quickTime or #videoForWindows |
Symbol |
Type |
Get/Set |
Description |
text |
string |
G/S |
The characters in the text field (null-terminated) |
textStyle |
string |
G/S |
The styles used in the text field, comma-delimited, combo of:
"bold", "italic" /FONT>, "underline",
"outline", "shadow", "condense",
"extend" |
textFont |
string |
G/S |
The font of the entire text field |
textHeight |
integer |
G/S |
The line height of every line in the text field |
textSize |
integer |
G/S |
The font size of every character in the text field |
foreColor |
integer |
G/S |
The foreground color index of every character in the text field |
backColor |
integer |
G/S |
The background color of the text field |
textAlign |
string |
G/S |
The alignment mode as a string: "left", "center",
"right" |
boxType |
symbol |
G/S |
Text box type: #adjust, #scroll, #fixed,
#limit |
border |
integer |
G/S |
Text border size (pixels) |
margin |
integer |
G/S |
Text margin size (pixels) |
scrollTop |
integer |
G/S |
Vertical scroll offset (pixels) |
dropShadow |
integer |
G/S |
Character drop shadow size (pixels) |
boxDropShadow |
integer |
G/S |
Box drop shadow size (pixels) |
autoTab |
integer |
G/S |
0=autoTab disabled, 1=autoTab enabled |
wordWrap |
integer |
G/S |
0=wordWrap disabled, 1=wordWrap enabled |
editable |
integer |
G/S |
0=not editable, 1=editable |
pageHeight |
integer |
G |
Vertical size of visible area (page) in scrolling field (pixels) |
lineCount |
integer |
G |
Number of lines in text field |
Name |
Returns |
Description |
lineHeight |
integer |
argument 1: line number. Returns height of specified line (pixels) |
linePosToLocV |
integer |
argument 1: linePosition. Returns vertical pixel offset
from line position |
locVtoLinePos |
integer |
argument 1: locV. Returns line position from vertical
pixel offset |
charPosToLoc |
point |
argument 1: character position. Returns (x,y) point offset for
given character |
locToCharPos |
integer |
argument 1: location (point). Returns character position from
given point |
scrollByPage |
void |
argument 1: page offset. Scroll up or down n pages (
n < 0 for down, n > 0 for up) |
scrollByLine |
void |
argument 1: line offset. Scroll up or down n lines (
n < 0 for down, n > 0 for up) |
Symbol |
Type |
Get/Set |
Description |
Notes |
active3DRenderer |
symbol |
G |
The current 3D renderer |
|
castCount |
integer |
G |
The number of casts (internal + external) in the movie |
|
createName |
string |
G/S |
Name of user who authored the movie |
May not be valid until movie is saved |
defaultColorDepth |
integer |
G |
Default color depth for new movies: 1,2,4,8,16,32. |
May not be valid until movie is saved |
defaultPalette |
castMem/symbol |
G/S |
Default palette for new movies |
CastMem (for cast-based pal) or Symbol (for built-in pal) value accepted |
defaultStageRect |
rect |
G |
Default stage rectangle for new movies |
May not be valid until movie is saved |
editShortCutsEnabled |
integer |
G/S |
Whether Cut/Copy/Paste shortcuts are functional |
|
enableFlashLingo |
integer |
G/S |
Whether Flash sprites can execute lingo commands with GetURL |
|
frame |
integer |
G/S |
The frame number where the playback head currently is |
Setting this does a "go to frame" |
lastChannel |
integer |
G |
The last graphic channel used by the movie |
|
modified |
integer |
G |
Whether the movie has been edited |
|
modifyName |
string |
G/S |
Name of user who last modified the movie |
May not be valid until movie is saved |
movieAboutInfo |
string |
G/S |
The "about" string for the movie |
|
movieCopyrightInfo |
string |
G/S |
The copyright string for the movie |
|
name |
string |
G |
Filename of the movie (not full path) |
|
pathName |
string |
G |
Full pathname of the movie |
|
playing |
integer |
G |
0 = movie is stopped in author mode, 1 = movie is playing |
|
preferred3dRenderer |
symbol |
G/S |
The preferred renderer for the movie |
|
remapPalettes |
integer |
G/S |
0 = don't remap bitmaps on the fly, 1 = remap to cur palette |
|
scriptExecutionStyle |
integer |
G/S |
9 for compatibility with DMX
10 for new DMX 2004 features |
|
stageColor |
integer |
G/S |
The palette index of the movie stage's background color |
Range depends on current pixel depth (0-255 max) |
tempo |
integer |
G/S |
Current tempo setting (requested tempo, not actual) |
|
version |
integer |
G |
Version of the movie file |
|
Authoring-only |
|
|
|
|
activeCastLib |
integer |
G |
Movie cast index of the "active" cast |
An active cast is one whose cast window was most recently active |
scoreSelection |
linear list |
G/S |
List indicating current score selection |
Only valid for main movie. It's a list of lists; each sublist specifies a rectangular portion of the selection.
For example, [[topSprite, bottomSprite, firstFrame, lastFrame]] |
Symbol |
Type |
Get/Set |
Description |
Notes |
authorMode |
integer |
G |
1 if authoring; 0 otherwise |
|
folderName |
string |
G |
Full pathname to the folder where the player library is located |
|
name |
string |
G |
Name of the player library |
DPLib.framework on macintosh
Dirapi.dll on windows |
pathName |
string |
G |
Full pathname of player library |
|
soundDevice |
integer |
G |
Index of current sound device |
|
screenScale |
float |
G |
iOS only, returns the current screenScale of the mainScreen. |
If it is 2.0, it means retina mode,
1.0 means non-retina mode |
Symbol |
Type |
Get/Set |
Description |
tempo |
integer |
G/S |
Frame tempo in FPS, 0 to clear cell completely |
waitSeconds |
integer |
G/S |
Wait in seconds, returns 0 if not waitSeconds, set
to 0 to clear cell |
waitClick |
integer |
G/S |
Wait for mouse click, returns 0 if not waitClick, set
to 0 to clear cell |
waitSound |
integer |
G/S |
Specify sound channel number (1-2), returns 0 if not waitSound,
set to 0 to clear cell |
waitDigitalVideo |
integer |
G/S |
Specify sprite channel number (1-48), returns 0 if not waitDigitalVideo,
set to 0 to clear cell |
palette |
integer |
G/S |
Access palette as integer (negative numbers indicate built-in
palettes), setting defaults to instant normal palette transition, set to
0 to clear cell |
paletteRef |
castMem
/symbol |
G/S |
Access palette as castMem/
symbol (symbols indicate built-in palettes), setting defaults to instant
normal palette transition, set to castMem(0,0) to clear cell |
paletteTransitionType |
symbol |
G/S |
"#normal, #fadeToBlack, #fadeToWhite>.
Setting this clears paletteOverTime to 0 |
paletteOverTime |
integer |
G/S |
0=transition palette between frames,
1 = transition palette over time,
setting to 1 ignores paletteSpeed |
paletteFrames |
integer |
G/S |
1-n,
setting > 0 switches to paletteOverTime, set to 0 to clear (turns
off overTime) |
paletteSpeed |
integer |
G/S |
1-30, setting this causes paletteOverTime to be ignored |
transition |
castMem |
G/S |
Transition castMemRef, set to castMem(0,0) to clear
cell |
script |
castMem |
G/S |
Script castMemRef, set to castMem(0,0) to clear cell |
Name |
Description |
kMoaDrMediaOpts_None |
Normal case when setting, getting, and attaching |
kMoaDrImgMediaOpts_AuthorDefined |
Assign pixel depth and palette for cast member based on author's
preferences. In Director 5.0, this is currently the stage window screen's
current pixel depth and palette. Supplied image data is remapped to this
pixel depth and pale tte when placed in the cast member. This option is
the default. |
kMoaDrImgMediaOpts_CastMemDepthAndPal |
Use the cast member's existing pixel depth and palette. Supplied
image data is remapped to this pixel depth & palette when placed in
the cast member. If there is no image data for the cast member yet, this
option is equivalent t o kMoaDrImgMediaOpts_AuthorDefined |
kMoaDrImgMediaOpts_ScreenDepthAndPal |
Use the stage window screen's current pixel depth and palette.
Supplied image data is remapped to this pixel depth & palette when placed
in the cast member. |
kMoaDrImgMediaOpts_Dialog |
Available in authoring application only. Invoke a dialog asking
the user whether to use the image's current pixel depth or the screen's.
Also, if it's an indexed image, user has the option of remapping to another
existing palette. I f pixel depth is being reduced or a new palette is requested,
the user can choose whether remapping or dithering should take place. |
kMoaDrImgMediaOpts_AuxInfo |
Explicitly specifies pixel depth, palette, and dither/remap
option. If set, the "aux" field must be a pointer to
a caller-owned MoaDrImageAuxInfo /FONT>structure. See DRTYPES.H.
|
kMoaDrImgMediaOpts_ImageDepthAndPal |
Use the supplied image's pixel depth and palette; don't do any
remapping. If it has a palette (it's an indexed image) and the palette doesn't
exist in the current movie's cast(s), a new palette cast member is created
automatically c ontaining the image's palette, and is assigned to the bitmap
cast member. |
Defined in: driservc.h.
Notification events are sent to Xtras that implement the