Director Help

unLoadMember()

Usage

-- Lingo syntax
_movie.unLoadMember({memberObjRef})
_movie.unLoadMember(fromMemberNameOrNum, toMemberNameOrNum)

// JavaScript syntax
_movie.unLoadMember({memberObjRef});
_movie.unLoadMember(fromMemberNameOrNum, toMemberNameOrNum);

Description

Movie method; forces Director to clear a specific cast member or a range of cast members from memory. Director automatically unloads the least recently used cast members to accommodate preLoad() methods or normal cast library loading.

  • When used without an argument, the unLoadMember() method clears from memory the cast members in all the frames of a movie.
  • When used with one argument, memberObjRef, the unLoadMember() method clears from memory the specified cast member.
  • When used with two arguments, fromMemberNameOrNum and toMemberNameOrNum, the unLoadMember() method unloads all cast members in the range specified. You can specify a range of cast members by member numbers or member names.

Parameters

memberObjRef Optional. A reference to the cast member to unload from memory.

fromMemberNameOrNum Required if clearing a range of cast members. A string or integer that specifies the name or number of the first cast member in a range to unload from memory.

toMemberNameOrNum Required if clearing a range of cast members. A string or integer that specifies the name or number of the last cast member in a range to unload from memory.

Example

This statement clears from memory the cast member Screen1:

-- Lingo syntax
_movie.unLoadMember(member("Screen1"))

// JavaScript syntax
_movie.unLoadMember(member("Screen1));

This statement clears from memory all cast members from cast member 1 to cast member Big Movie:

-- Lingo syntax
_movie.unLoadMember(member(1), member("Big Movie"))

// JavaScript syntax
_movie.unLoadMember(member(1), member("Big Movie"));

See also

Movie unLoad() (Member) unLoad() (Movie) unLoadMovie()