Changeset 150 for trunk/lingosource/castlib2/commonMovieScript.ls

Timestamp:

02/18/08 06:02:53 (4 years ago)

Author:

alex

Message:

update library scripts

File:

• trunk/lingosource/castlib2/commonMovieScript.ls (modified) (14 diffs)

trunk/lingosource/castlib2/commonMovieScript.ls

@@ -1 @@
--- Shared Global Handlers ©03 Alex da Franca -- alex@farbflash.de
----------------------------------------------------------------------
-
-
--- these handlers are shared between all of my scripts Alex da Franca ©2003 alex@farbflash.de
--- for private use of my scripts -> poor documentation -> use at own risk ;-)
-
--- geaendert am 21.06.03
--- mGetInstance 0 -- clears all stored instances -> same as recompile all scripts, but that would clear all contents of (script "commonMovieScript").pGList
--- mApplyDynamic
-
--- alex am 13.03.2004 um 13:49
--- added DEBUG_FUNCTIONS
-
--- alex am 15.03.2004 um 08:50
--- added mGetPlatform() to get OSX
--- alex am 31.03.2004 um 11:42
--- added clearglobals to mDestroy handler
-
--- added support for new director MX2004 sprite names in my handlers by changing mGetKanal() to accept strings
-
--- alex am Freitag, 4. Juni 2004
--- took care about missing font asset xtra, if it isn't present, we'll get not a script error anymore
--- but rather the presence of the font is not checked instead, but rather assumed
-
--- alex am 16. Juni 2004 um 10:12
--- added mGetNextLowerPowerOfTwo
-
--- alex am 18. Juli 2004 um 08:02
--- added mMyClearGlobals() to erase the faked globals and get the new globallist
-
--- alex am 8. Oktober 2004 um 10:31
--- new tempmember handling due to a bug in director
-
--- alex am 23. November 2004 um 10:59
--- added mGetThisMovieName() and mSetThisMovieName() to identify the movie independant of the filename
--- this is needed for some places, where the standard scripts act differently in the different movies
-
--- Scriptmarker (21.07.2005 at 11:55 Uhr): changes // Scriptmarker
--- added mSplitPath
-
-
-
-
--- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
--- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-
--- IMPORTANT NOTE !!
--- if you use my scripts you MUST call 'mCallDestroy()' at stopmovie in order to clean up temporary members used by my scripts
--- due to a bug in director I had to change the old behaavior of erasing the members on endsprite, when I was done with it !
--- so now I use a list of temporary members, which is maintained during runtime, but must be processed when the movie is stopped
--- (unless you want to fill up your castlib with temporary members :-)
-
--- NOW:
--- if this script is NOT the first moviescript in your movie containing a stopmovie handler this one gets overriddden and
--- you must call 'mCallDestroy()' in your stopmovie handler.
--- otherwise when it this script comes before your script with the stopmovie handler your handler will never be called
--- since the stopmovie event is caught here...
--- in that case just comment it out here and add the 'mCallDestroy()' to your own stopmovie handler
-
---on stopmovie me
---  mCallDestroy
---end
+-- commonMovieScript
+-----------------------------------
+-- CREATED:
+--              11.02.2008
+--
+-- DESCRIPTION:      
+--              Shared Global Handlers ©03 Alex da Franca -- alex@farbflash.de
+--              -------------------------------------------------------------------
+--              these handlers are shared between all of my scripts Alex da Franca ©2003 alex@farbflash.de
+--              for private use of my scripts -> poor documentation -> use at own risk ;-)
+
+-- HISTORY:
+--              geaendert am 21.06.03
+--              mGetInstance 0 -- clears all stored instances -> same as recompile all scripts, but that would clear all contents of (script "commonMovieScript").pGList
+--              mApplyDynamic
+
+--              alex am 13.03.2004 um 13:49
+--              added DEBUG_FUNCTIONS
+
+--              alex am 15.03.2004 um 08:50
+--              added mGetPlatform() to get OSX
+--              alex am 31.03.2004 um 11:42
+--              added clearglobals to mDestroy handler
+
+--              added support for new director MX2004 sprite names in my handlers by changing mGetKanal() to accept strings
+
+--              alex am Freitag, 4. Juni 2004
+--              took care about missing font asset xtra, if it isn't present, we'll get not a script error anymore
+--              but rather the presence of the font is not checked instead, but rather assumed
+
+--              alex am 16. Juni 2004 um 10:12
+--              added mGetNextLowerPowerOfTwo
+
+--              alex am 18. Juli 2004 um 08:02
+--              added mMyClearGlobals() to erase the faked globals and get the new globallist
+
+--              alex am 8. Oktober 2004 um 10:31
+--              new tempmember handling due to a bug in director
+
+--              alex am 23. November 2004 um 10:59
+--              added mGetThisMovieName() and mSetThisMovieName() to identify the movie independant of the filename
+--              this is needed for some places, where the standard scripts act differently in the different movies
+
+--              Scriptmarker (21.07.2005 at 11:55 Uhr): changes // Scriptmarker
+--              added mSplitPath
+
+--
+-- WARNINGS:
+--              IMPORTANT NOTE !!
+--              if you use my scripts you MUST call 'mCallDestroy()' at stopmovie in order to clean up temporary members used by my scripts
+--              due to a bug in director I had to change the old behaavior of erasing the members on endsprite, when I was done with it !
+--              so now I use a list of temporary members, which is maintained during runtime, but must be processed when the movie is stopped
+--              (unless you want to fill up your castlib with temporary members :-)
+
+--              If this script is NOT the first moviescript in your movie containing a stopmovie handler this one gets overriddden and
+--              you must call 'mCallDestroy()' in your stopmovie handler.
+--              otherwise when it this script comes before your script with the stopmovie handler your handler will never be called
+--              since the stopmovie event is caught here...
+--              in that case just comment it out here and add the 'mCallDestroy()' to your own stopmovie handler
+
+--              on stopmovie me
+--              mCallDestroy
+--              end
+-- TODO:
+--              -
+-----------------------------------
 
 -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
@@ -72 +75 @@
 
 on mGetGlobalList me
+  -----------------------------------
+  --         ACTION: We keep a list of "faked global variables"
+  --                 Using real global variables has the drawback,
+  --                 that they may clash with the host movies globals
+  --                 and even worse: all movie instances running in the same player
+  --                 instance -> MIAWs share only one global space
+  --                 Since these scripts are also used in my authoring tools
+  --                 they can behave nicely, if running as miaws in any environment
+  --         INPUT: -
+  --         RETURNS: property list with global variables
+  --         NOTES: If possible only use the set and get handlers (mSetGlobalValue, mGetGlobalValue)
+  -----------------------------------
+  
   if voidP(pGList) then
     pGList = [:]
@@ -86 +102 @@
 
 on mMyClearGlobals me
+  -----------------------------------
+  --         CREATED: 11.02.2008
+  --         ACTION: Clear the global list at runtime (at authortime a "Recompile all scripts" does the same)
+  --                 See description for "Faked globals" at handler [#mGetGlobalList_commonMovieScript mGetGlobalList]
+  --         INPUT: -
+  --         RETURNS: -
+  -----------------------------------
+  
   pGList = [:]
   return pGList
@@ -94 +118 @@
 
 on mSetGlobalValue me, propName, newValue
+  -----------------------------------
+  --         ACTION: Set the value for a "global" variable
+  --                 If the "global" with the name #propname doesn't exits it gets created
+  
+  --                 Interface to the "private globals" stored in this uninstatiated script as property
+  --                 See description for "Faked globals" at handler [#mGetGlobalList_commonMovieScript mGetGlobalList]
+  
+  --         INPUT: propName: symbol; name of global value
+  --                newValue: any value
+  --         RETURNS: -
+  -----------------------------------
+  
   g = mGetGlobalList(me)
   g.setaprop(propName, newValue)
@@ -102 +138 @@
 
 on mGetGlobalValue me, propName
+  -----------------------------------
+  --         ACTION: Get the value for a "global" variable
+  --                 If the "global" with the name #propname doesn't exits it returns void
+  
+  --                 Interface to the "private globals" stored in this uninstatiated script as property
+  --                 See description for "Faked globals" at handler [#mGetGlobalList_commonMovieScript mGetGlobalList]
+  
+  --         INPUT: propName: symbol; name of global value
+  --         RETURNS: -
+  -----------------------------------
+  
   g = mGetGlobalList(me)
   return g.getaprop(propName)
@@ -109 +156 @@
 
 on mCallDestroy me
+  -----------------------------------
+  --         CREATED: 12.02.2008
+  --         ACTION: Call to clean everything up on stopmovie
+  --         INPUT: -
+  --         RETURNS: -
+  -----------------------------------
+  
   
   sendAllSprites(#mStopMovieWasCalled)
@@ -154 +208 @@
 -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 -- xxxxxxxxxxxxxxxxxx color( -> rgb(
--- fix the score data which has #color instead of #rgb when authored with D10, which fails with the older player
+-- 
 
 on Authoring_ExchangeScriptListColorsToRGBs me
+  -----------------------------------
+  --         CREATED: 12.02.2008
+  --         ACTION: fix the score data which has #color instead of #rgb when authored with D10
+  --                 which fails with the older player (AUTHORING ONLY!)
+  --         INPUT: -
+  --         RETURNS: -
+  -----------------------------------
+  
   theLastFrame = the lastFrame
   theLastChannel = the lastChannel
@@ -213 +275 @@
 
 on mGetVersionNumber me
+  -----------------------------------
+  --         CREATED: 12.02.2008
+  --         ACTION: Get player veersion number as float, so that proper maths can be made
+  --         INPUT: -
+  --         RETURNS: float => director player version number
+  -----------------------------------
   
   glob = mGetGlobalList(me)
@@ -251 +319 @@
 
 on mGetPlatform me
+  -----------------------------------
+  --         CREATED: 12.02.2008
+  --         ACTION: Get the platform as symbol
+  --                 the advantage is that the result is cached in the global list
+  --                 and the distinction between OS9 and OSX is made
+  --         INPUT: -
+  --         RETURNS: symbol => platform identifier; range: #os9, #osx, #win
+  -----------------------------------
   
   glob = mGetGlobalList(me)
@@ -276 +352 @@
 
 on mCheckMemberType me, memref, aType
+  -----------------------------------
+  --         CREATED: 12.02.2008
+  --         ACTION: Check if the member reference <memref> is of type <aType>
+  --                 This handler works in D<10 and D>=10
+  --         INPUT: member reference
+  --                symbol
+  --         RETURNS: boolean (integer)
+  -----------------------------------
+  
   if voidP(memref) then return 0
   return (memref.type = aType)
@@ -283 +368 @@
 
 on mGetMemType me, memref
+  -----------------------------------
+  --         CREATED: 12.02.2008
+  --         ACTION: Return the type of member <memref>
+  --                 This handler works in D<10 and D>=10
+  --                 If memref is not a valid member this handler returns #empty, like D<10 used to
+  --         INPUT: member reference
+  --         RETURNS: symbol => member type; range: every member type and #empty
+  -----------------------------------
   if ilk(memref) <> #member then return #empty
   return memref.type
@@ -290 +383 @@
 
 on mCreateTimeout me, theName, theDuration, theHandler, theTarget
+  -----------------------------------
+  --         CREATED: 12.02.2008
+  --         ACTION: Create/Get timeout object
+  --                 This handler works the same with the old player <10 and the new player >=10
+  --         INPUT: ||ÊtheName     || string  || name for new timeout object||
+  --                ||ÊtheDuration || integer || timeout perios in milliseconds||
+  --                || theHandler  || symbol  || handler to be called on each timepout event||
+  --                || theTarget   || object  || object to be sent the timeout event <theHandler>||
+  --         RETURNS: timeout object
+  -----------------------------------
   
   dto = timeout(theName)
@@ -1392 +1495 @@
   
   if delim = "\" then
+    if length(thePath) > 1 then
     if thePath.char[2] = ":" then
       num = charToNum(thePath.char[1])
@@ -1400 +1504 @@
         praef = ""
       end if
+    else
+      praef = ""
+    end if
     else
       praef = ""