From 0cc4c6fffc089ea40bfd864cc4fd64c0684a1f25 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sat, 3 Feb 2007 18:54:54 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228896 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/swf/functions/swf-actiongeturl.xml | 40 ++-- .../swf/functions/swf-actiongotoframe.xml | 38 +-- .../swf/functions/swf-actiongotolabel.xml | 40 ++-- .../swf/functions/swf-actionnextframe.xml | 34 +-- reference/swf/functions/swf-actionplay.xml | 36 ++- .../swf/functions/swf-actionprevframe.xml | 34 +-- .../swf/functions/swf-actionsettarget.xml | 38 +-- reference/swf/functions/swf-actionstop.xml | 36 ++- .../swf/functions/swf-actiontogglequality.xml | 36 ++- .../swf/functions/swf-actionwaitforframe.xml | 48 ++-- .../swf/functions/swf-addbuttonrecord.xml | 70 +++--- reference/swf/functions/swf-addcolor.xml | 68 +++--- reference/swf/functions/swf-closefile.xml | 74 +++--- reference/swf/functions/swf-definebitmap.xml | 40 ++-- reference/swf/functions/swf-definefont.xml | 46 ++-- reference/swf/functions/swf-defineline.xml | 56 ++--- reference/swf/functions/swf-definepoly.xml | 56 +++-- reference/swf/functions/swf-definerect.xml | 58 ++--- reference/swf/functions/swf-definetext.xml | 46 ++-- reference/swf/functions/swf-endbutton.xml | 38 ++- reference/swf/functions/swf-enddoaction.xml | 36 +-- reference/swf/functions/swf-endshape.xml | 38 ++- reference/swf/functions/swf-endsymbol.xml | 38 +-- reference/swf/functions/swf-fontsize.xml | 38 +-- reference/swf/functions/swf-fontslant.xml | 38 +-- reference/swf/functions/swf-fonttracking.xml | 42 ++-- reference/swf/functions/swf-getbitmapinfo.xml | 74 +++--- reference/swf/functions/swf-getfontinfo.xml | 62 +++-- reference/swf/functions/swf-getframe.xml | 36 +-- reference/swf/functions/swf-labelframe.xml | 36 +-- reference/swf/functions/swf-lookat.xml | 62 ++--- reference/swf/functions/swf-modifyobject.xml | 58 ++--- reference/swf/functions/swf-mulcolor.xml | 68 +++--- reference/swf/functions/swf-nextid.xml | 36 +-- reference/swf/functions/swf-oncondition.xml | 222 +++++++++--------- reference/swf/functions/swf-openfile.xml | 72 +++--- reference/swf/functions/swf-ortho.xml | 49 ++-- reference/swf/functions/swf-ortho2.xml | 51 ++-- reference/swf/functions/swf-perspective.xml | 70 +++--- reference/swf/functions/swf-placeobject.xml | 64 ++--- reference/swf/functions/swf-polarview.xml | 66 +++--- reference/swf/functions/swf-popmatrix.xml | 38 ++- reference/swf/functions/swf-posround.xml | 47 ++-- reference/swf/functions/swf-pushmatrix.xml | 38 ++- reference/swf/functions/swf-removeobject.xml | 36 +-- reference/swf/functions/swf-rotate.xml | 44 ++-- reference/swf/functions/swf-scale.xml | 46 ++-- reference/swf/functions/swf-setfont.xml | 36 +-- reference/swf/functions/swf-setframe.xml | 36 +-- reference/swf/functions/swf-shapearc.xml | 54 ++--- reference/swf/functions/swf-shapecurveto.xml | 56 +++-- reference/swf/functions/swf-shapecurveto3.xml | 58 ++--- .../swf/functions/swf-shapefillbitmapclip.xml | 40 ++-- .../swf/functions/swf-shapefillbitmaptile.xml | 40 ++-- reference/swf/functions/swf-shapefilloff.xml | 36 +-- .../swf/functions/swf-shapefillsolid.xml | 46 ++-- .../swf/functions/swf-shapelinesolid.xml | 50 ++-- reference/swf/functions/swf-shapelineto.xml | 42 ++-- reference/swf/functions/swf-shapemoveto.xml | 42 ++-- reference/swf/functions/swf-showframe.xml | 34 +-- reference/swf/functions/swf-startbutton.xml | 46 ++-- reference/swf/functions/swf-startdoaction.xml | 40 ++-- reference/swf/functions/swf-startshape.xml | 38 +-- reference/swf/functions/swf-startsymbol.xml | 40 ++-- reference/swf/functions/swf-textwidth.xml | 38 +-- reference/swf/functions/swf-translate.xml | 44 ++-- reference/swf/functions/swf-viewport.xml | 48 ++-- 67 files changed, 1622 insertions(+), 1679 deletions(-) diff --git a/reference/swf/functions/swf-actiongeturl.xml b/reference/swf/functions/swf-actiongeturl.xml index e228a47b8f..159b05eb49 100644 --- a/reference/swf/functions/swf-actiongeturl.xml +++ b/reference/swf/functions/swf-actiongeturl.xml @@ -1,25 +1,25 @@ - + - - - swf_actiongeturl - Get a URL from a Shockwave Flash movie - - - Description - - voidswf_actiongeturl - stringurl - stringtarget - - - The swf_actiongeturl function gets the URL - specified by the parameter url with the - target target. - - - + + + swf_actiongeturl + Get a URL from a Shockwave Flash movie + + + Description + + voidswf_actiongeturl + stringurl + stringtarget + + + The swf_actiongeturl function gets the URL + specified by the parameter url with the + target target. + + + + - - - swf_actiongotoframe - Play a frame and then stop - - - Description - - voidswf_actiongotoframe - intframenumber - - - The swf_actiongotoframe function will go to - the frame specified by framenumber, play - it, and then stop. - - - + + + swf_actiongotoframe + Play a frame and then stop + + + Description + + voidswf_actiongotoframe + intframenumber + + + The swf_actiongotoframe function will go to + the frame specified by framenumber, play + it, and then stop. + + + + - - - swf_actiongotolabel - - Display a frame with the specified label - - - - Description - - voidswf_actiongotolabel - stringlabel - - - The swf_actiongotolabel function displays - the frame with the label given by the - label parameter and then stops. - - - + + + swf_actiongotolabel + Display a frame with the specified label + + + Description + + voidswf_actiongotolabel + stringlabel + + + The swf_actiongotolabel function displays + the frame with the label given by the + label parameter and then stops. + + + + - - - swf_actionnextframe - Go forward one frame - - - Description - - voidswf_actionnextframe - - - - Go forward one frame. - - - + + + swf_actionnextframe + Go forward one frame + + + Description + + voidswf_actionnextframe + + + + Go forward one frame. + + + + - - - swf_actionplay - - Start playing the flash movie from the current frame - - - - Description - - voidswf_actionplay - - - - Start playing the flash movie from the current frame. - - - + + + swf_actionplay + Start playing the flash movie from the current frame + + + Description + + voidswf_actionplay + + + + Start playing the flash movie from the current frame. + + + + - - - swf_actionprevframe - Go backwards one frame - - - Description - - voidswf_actionprevframe - - - - &warn.undocumented.func; - - - + + + swf_actionprevframe + Go backwards one frame + + + Description + + voidswf_actionprevframe + + + + &warn.undocumented.func; + + + + - - - swf_actionsettarget - Set the context for actions - - - Description - - voidswf_actionsettarget - stringtarget - - - The swf_actionsettarget function sets the - context for all actions. You can use this to control other flash - movies that are currently playing. - - - + + + swf_actionsettarget + Set the context for actions + + + Description + + voidswf_actionsettarget + stringtarget + + + The swf_actionsettarget function sets the + context for all actions. You can use this to control other flash + movies that are currently playing. + + + + - - - swf_actionstop - - Stop playing the flash movie at the current frame - - - - Description - - voidswf_actionstop - - - - Stop playing the flash movie at the current frame. - - - + + + swf_actionstop + Stop playing the flash movie at the current frame + + + Description + + voidswf_actionstop + + + + Stop playing the flash movie at the current frame. + + + + - - - swf_actiontogglequality - - Toggle between low and high quality - - - - Description - - voidswf_actiontogglequality - - - - Toggle the flash movie between high and low quality. - - - + + + swf_actiontogglequality + Toggle between low and high quality + + + Description + + voidswf_actiontogglequality + + + + Toggle the flash movie between high and low quality. + + + + - - - swf_actionwaitforframe - - Skip actions if a frame has not been loaded - - - - Description - - voidswf_actionwaitforframe - intframenumber - intskipcount - - - The swf_actionwaitforframe function will - check to see if the frame, specified by the - framenumber parameter has been loaded, if - not it will skip the number of actions specified by the - skipcount parameter. This can be useful - for "Loading..." type animations. - - - + + + swf_actionwaitforframe + Skip actions if a frame has not been loaded + + + Description + + voidswf_actionwaitforframe + intframenumber + intskipcount + + + The swf_actionwaitforframe function will + check to see if the frame, specified by the + framenumber parameter has been loaded, if + not it will skip the number of actions specified by the + skipcount parameter. This can be useful + for "Loading..." type animations. + + + + - - - swf_addbuttonrecord - - Controls location, appearance and active area of the current button - - - - Description - - voidswf_addbuttonrecord - intstates - intshapeid - intdepth - - - The swf_addbuttonrecord function allows you - to define the specifics of using a button. The first parameter, - states, defines what states the button can - have, these can be any or all of the following constants: - BSHitTest, BSDown, BSOver or BSUp. The second parameter, the - shapeid is the look of the button, this is - usually the object id of the shape of the button. The - depth parameter is the placement of the - button in the current frame. - - - <function>swf_addbuttonrecord</function> example - - + + + swf_addbuttonrecord + Controls location, appearance and active area of the current button + + + Description + + voidswf_addbuttonrecord + intstates + intshapeid + intdepth + + + The swf_addbuttonrecord function allows you + to define the specifics of using a button. The first parameter, + states, defines what states the button can + have, these can be any or all of the following constants: + BSHitTest, BSDown, BSOver or BSUp. The second parameter, the + shapeid is the look of the button, this is + usually the object id of the shape of the button. The + depth parameter is the placement of the + button in the current frame. + + + <function>swf_addbuttonrecord</function> example + + ]]> - - - - - + + + + + + - - - swf_addcolor - - Set the global add color to the rgba value specified - - - - Description - - voidswf_addcolor - floatr - floatg - floatb - floata - - - The swf_addcolor function sets the global - add color to the rgba color specified. - This color is then used (implicitly) by the - swf_placeobject, - swf_modifyobject and the - swf_addbuttonrecord functions. The color of - the object will be add by the rgba values - when the object is written to the screen. - - - - The rgba values can be either positive or - negative. - - - - + + + swf_addcolor + Set the global add color to the rgba value specified + + + Description + + voidswf_addcolor + floatr + floatg + floatb + floata + + + The swf_addcolor function sets the global + add color to the rgba color specified. + This color is then used (implicitly) by the + swf_placeobject, + swf_modifyobject and the + swf_addbuttonrecord functions. The color of + the object will be add by the rgba values + when the object is written to the screen. + + + + The rgba values can be either positive or + negative. + + + + + - - - swf_closefile - Close the current Shockwave Flash file - - - Description - - voidswf_closefile - int - return_file - - - - Close a file that was opened by the - swf_openfile function. If the - return_file parameter is set then the contents - of the SWF file are returned from the function. - - - - - Creating a simple flash file based on user input and outputting it - and saving it in a database - - + + + swf_closefile + Close the current Shockwave Flash file + + + Description + + voidswf_closefile + intreturn_file + + + Close a file that was opened by the + swf_openfile function. If the + return_file parameter is set then the contents + of the SWF file are returned from the function. + + + + + Creating a simple flash file based on user input and outputting it + and saving it in a database + + ]]> - - - - - + + + + + + - - - swf_definebitmap - Define a bitmap - - - Description - - voidswf_definebitmap - intobjid - stringimage_name - - - The swf_definebitmap function defines a - bitmap given a GIF, JPEG, RGB or FI image. The image will be - converted into a Flash JPEG or Flash color map format. - - - + + + swf_definebitmap + Define a bitmap + + + Description + + voidswf_definebitmap + intobjid + stringimage_name + + + The swf_definebitmap function defines a + bitmap given a GIF, JPEG, RGB or FI image. The image will be + converted into a Flash JPEG or Flash color map format. + + + + - - - swf_definefont - - Defines a font - - - - Description - - voidswf_definefont - intfontid - stringfontname - - - The swf_definefont function defines a font - given by the fontname parameter and gives - it the id specified by the fontid - parameter. It then sets the font given by - fontname to the current font. - - - + + + swf_definefont + Defines a font + + + Description + + voidswf_definefont + intfontid + stringfontname + + + The swf_definefont function defines a font + given by the fontname parameter and gives + it the id specified by the fontid + parameter. It then sets the font given by + fontname to the current font. + + + + - - - swf_defineline - Define a line - - - Description - - voidswf_defineline - intobjid - floatx1 - floaty1 - floatx2 - floaty2 - floatwidth - - - The swf_defineline defines a line starting - from the x coordinate given by x1 and the - y coordinate given by y1 parameter. Up - to the x coordinate given by the x2 - parameter and the y coordinate given by the - y2 parameter. It will have a width - defined by the width parameter. - - - + + + swf_defineline + Define a line + + + Description + + voidswf_defineline + intobjid + floatx1 + floaty1 + floatx2 + floaty2 + floatwidth + + + The swf_defineline defines a line starting + from the x coordinate given by x1 and the + y coordinate given by y1 parameter. Up + to the x coordinate given by the x2 + parameter and the y coordinate given by the + y2 parameter. It will have a width + defined by the width parameter. + + + + - - - swf_definepoly - - Define a polygon - - - - Description - - voidswf_definepoly - intobjid - arraycoords - intnpoints - floatwidth - - - The swf_definepoly function defines a - polygon given an array of x, y coordinates (the coordinates are - defined in the parameter coords). The - parameter npoints is the number of overall - points that are contained in the array given by - coords. The width - is the width of the polygon's border, if set to 0.0 the polygon - is filled. - - - + + + swf_definepoly + Define a polygon + + + Description + + voidswf_definepoly + intobjid + arraycoords + intnpoints + floatwidth + + + The swf_definepoly function defines a + polygon given an array of x, y coordinates (the coordinates are + defined in the parameter coords). The + parameter npoints is the number of overall + points that are contained in the array given by + coords. The width + is the width of the polygon's border, if set to 0.0 the polygon + is filled. + + + + - - - swf_definerect - Define a rectangle - - - Description - - voidswf_definerect - intobjid - floatx1 - floaty1 - floatx2 - floaty2 - floatwidth - - - The swf_definerect defines a rectangle with - an upper left hand coordinate given by the x, - x1, and the y, y1. - And a lower right hand coordinate given by the x coordinate, - x2, and the y coordinate, y2 - . Width of the rectangles border is given by the - width parameter, if the width is 0.0 then - the rectangle is filled. - - - + + + swf_definerect + Define a rectangle + + + Description + + voidswf_definerect + intobjid + floatx1 + floaty1 + floatx2 + floaty2 + floatwidth + + + The swf_definerect defines a rectangle with + an upper left hand coordinate given by the x, + x1, and the y, y1. + And a lower right hand coordinate given by the x coordinate, + x2, and the y coordinate, y2 + . Width of the rectangles border is given by the + width parameter, if the width is 0.0 then + the rectangle is filled. + + + + - - - swf_definetext - Define a text string - - - Description - - voidswf_definetext - intobjid - stringstr - intdocenter - - - Define a text string (the str parameter) - using the current font and font size. The - docenter is where the word is centered, if - docenter is 1, then the word is centered - in x. - - - + + + swf_definetext + Define a text string + + + Description + + voidswf_definetext + intobjid + stringstr + intdocenter + + + Define a text string (the str parameter) + using the current font and font size. The + docenter is where the word is centered, if + docenter is 1, then the word is centered + in x. + + + + - - - swf_endbutton - - End the definition of the current button - - - - Description - - voidswf_endbutton - - - - The swf_endbutton function ends the - definition of the current button. - - - + + + swf_endbutton + End the definition of the current button + + + Description + + voidswf_endbutton + + + + The swf_endbutton function ends the + definition of the current button. + + + + - - - swf_enddoaction - End the current action - - - Description - - voidswf_enddoaction - - - - Ends the current action started by the - swf_startdoaction function. - - - + + + swf_enddoaction + End the current action + + + Description + + voidswf_enddoaction + + + + Ends the current action started by the + swf_startdoaction function. + + + + - - - swf_endshape - - Completes the definition of the current shape - - - - Description - - voidswf_endshape - - - - The swf_endshape completes the definition of - the current shape. - - - + + + swf_endshape + Completes the definition of the current shape + + + Description + + voidswf_endshape + + + + The swf_endshape completes the definition of + the current shape. + + + + - - - swf_endsymbol - End the definition of a symbol - - - Description - - voidswf_endsymbol - - - - The swf_endsymbol function ends the - definition of a symbol that was started by the - swf_startsymbol function. - - - + + + swf_endsymbol + End the definition of a symbol + + + Description + + voidswf_endsymbol + + + + The swf_endsymbol function ends the + definition of a symbol that was started by the + swf_startsymbol function. + + + + - - - swf_fontsize - Change the font size - - - Description - - voidswf_fontsize - floatsize - - - The swf_fontsize function changes the font - size to the value given by the size - parameter. - - - + + + swf_fontsize + Change the font size + + + Description + + voidswf_fontsize + floatsize + + + The swf_fontsize function changes the font + size to the value given by the size + parameter. + + + + - - - swf_fontslant - Set the font slant - - - Description - - voidswf_fontslant - floatslant - - - Set the current font slant to the angle indicated by the - slant parameter. Positive values create a - forward slant, negative values create a negative slant. - - - + + + swf_fontslant + Set the font slant + + + Description + + voidswf_fontslant + floatslant + + + Set the current font slant to the angle indicated by the + slant parameter. Positive values create a + forward slant, negative values create a negative slant. + + + + - - - swf_fonttracking - Set the current font tracking - - - Description - - voidswf_fonttracking - floattracking - - - Set the font tracking to the value specified by the - tracking parameter. This function is used - to increase the spacing between letters and text, positive values - increase the space and negative values decrease the space between - letters. - - - + + + swf_fonttracking + Set the current font tracking + + + Description + + voidswf_fonttracking + floattracking + + + Set the font tracking to the value specified by the + tracking parameter. This function is used + to increase the spacing between letters and text, positive values + increase the space and negative values decrease the space between + letters. + + + + - - - swf_getbitmapinfo - Get information about a bitmap - - - Description - - arrayswf_getbitmapinfo - intbitmapid - - - The swf_getbitmapinfo function returns an - array of information about a bitmap given by the - bitmapid parameter. The returned array - has the following elements: - - - - "size" - The size in bytes of the bitmap. - - - - - "width" - The width in pixels of the bitmap. - - - - - "height" - The height in pixels of the bitmap. - - - - - - + + + swf_getbitmapinfo + Get information about a bitmap + + + Description + + arrayswf_getbitmapinfo + intbitmapid + + + The swf_getbitmapinfo function returns an + array of information about a bitmap given by the + bitmapid parameter. The returned array + has the following elements: + + + + "size" - The size in bytes of the bitmap. + + + + + "width" - The width in pixels of the bitmap. + + + + + "height" - The height in pixels of the bitmap. + + + + + + + - - - swf_getfontinfo - - The height in pixels of a capital A and a lowercase x - - - - Description - - arrayswf_getfontinfo - - - - The swf_getfontinfo function returns an - associative array with the following parameters: - - - - Aheight - The height in pixels of a capital A. - - - - - xheight - The height in pixels of a lowercase x. - - - - - - + + + swf_getfontinfo + The height in pixels of a capital A and a lowercase x + + + Description + + arrayswf_getfontinfo + + + + The swf_getfontinfo function returns an + associative array with the following parameters: + + + + Aheight - The height in pixels of a capital A. + + + + + xheight - The height in pixels of a lowercase x. + + + + + + + - - - swf_getframe - Get the frame number of the current frame - - - Description - - intswf_getframe - - - - The swf_getframe function gets the number of - the current frame. - - - + + + swf_getframe + Get the frame number of the current frame + + + Description + + intswf_getframe + + + + The swf_getframe function gets the number of + the current frame. + + + + - - - swf_labelframe - Label the current frame - - - Description - - voidswf_labelframe - stringname - - - Label the current frame with the name given by the - name parameter. - - - + + + swf_labelframe + Label the current frame + + + Description + + voidswf_labelframe + stringname + + + Label the current frame with the name given by the + name parameter. + + + + - - - swf_lookat - Define a viewing transformation - - - Description - - voidswf_lookat - floatview_x - floatview_y - floatview_z - floatreference_x - floatreference_y - floatreference_z - floattwist - - - The swf_lookat function defines a viewing - transformation by giving the viewing position (the parameters - view_x, view_y, and - view_z) and the coordinates of a reference - point in the scene, the reference point is defined by the - reference_x, reference_y - , and reference_z parameters. - The twist controls the rotation along - with viewer's z axis. - - - + + + swf_lookat + Define a viewing transformation + + + Description + + voidswf_lookat + floatview_x + floatview_y + floatview_z + floatreference_x + floatreference_y + floatreference_z + floattwist + + + The swf_lookat function defines a viewing + transformation by giving the viewing position (the parameters + view_x, view_y, and + view_z) and the coordinates of a reference + point in the scene, the reference point is defined by the + reference_x, reference_y + , and reference_z parameters. + The twist controls the rotation along + with viewer's z axis. + + + + - - - swf_modifyobject - Modify an object - - - Description - - voidswf_modifyobject - intdepth - inthow - - - Updates the position and/or color of the object at the specified - depth, depth. The parameter - how determines what is updated. - how can either be the constant MOD_MATRIX - or MOD_COLOR or it can be a combination of both - (MOD_MATRIX|MOD_COLOR). - - - MOD_COLOR uses the current mulcolor (specified by the function - swf_mulcolor) and addcolor (specified by the - function swf_addcolor) to color the object. - MOD_MATRIX uses the current matrix to position the object. - - - + + + swf_modifyobject + Modify an object + + + Description + + voidswf_modifyobject + intdepth + inthow + + + Updates the position and/or color of the object at the specified + depth, depth. The parameter + how determines what is updated. + how can either be the constant MOD_MATRIX + or MOD_COLOR or it can be a combination of both + (MOD_MATRIX|MOD_COLOR). + + + MOD_COLOR uses the current mulcolor (specified by the function + swf_mulcolor) and addcolor (specified by the + function swf_addcolor) to color the object. + MOD_MATRIX uses the current matrix to position the object. + + + + - - - swf_mulcolor - - Sets the global multiply color to the rgba value specified - - - - Description - - voidswf_mulcolor - floatr - floatg - floatb - floata - - - The swf_mulcolor function sets the global - multiply color to the rgba color - specified. This color is then used (implicitly) by the - swf_placeobject, - swf_modifyobject and the - swf_addbuttonrecord functions. The color of - the object will be multiplied by the rgba - values when the object is written to the screen. - - - - The rgba values can be either positive or - negative. - - - - + + + swf_mulcolor + Sets the global multiply color to the rgba value specified + + + Description + + voidswf_mulcolor + floatr + floatg + floatb + floata + + + The swf_mulcolor function sets the global + multiply color to the rgba color + specified. This color is then used (implicitly) by the + swf_placeobject, + swf_modifyobject and the + swf_addbuttonrecord functions. The color of + the object will be multiplied by the rgba + values when the object is written to the screen. + + + + The rgba values can be either positive or + negative. + + + + + - - - swf_nextid - Returns the next free object id - - - Description - - intswf_nextid - - - - The swf_nextid function returns the next - available object id. - - - + + + swf_nextid + Returns the next free object id + + + Description + + intswf_nextid + + + + The swf_nextid function returns the next + available object id. + + + + - - - swf_oncondition - - Describe a transition used to trigger an action list - - - - Description - - voidswf_oncondition - inttransition - - - The swf_oncondition function describes a - transition that will trigger an action list. There are several - types of possible transitions, the following are for buttons - defined as TYPE_MENUBUTTON: - - - - IdletoOverUp - - - - - OverUptoIdle - - - - - OverUptoOverDown - - - - - OverDowntoOverUp - - - - - IdletoOverDown - - - - - OutDowntoIdle - - - - - MenuEnter (IdletoOverUp|IdletoOverDown) - - - - - MenuExit (OverUptoIdle|OverDowntoIdle) - - - - For TYPE_PUSHBUTTON there are the following options: - - - - IdletoOverUp - - - - - OverUptoIdle - - - - - OverUptoOverDown - - - - - OverDowntoOverUp - - - - - OverDowntoOutDown - - - - - OutDowntoOverDown - - - - - OutDowntoIdle - - - - - ButtonEnter (IdletoOverUp|OutDowntoOverDown) - - - - - ButtonExit (OverUptoIdle|OverDowntoOutDown) - - - - - - + + + swf_oncondition + Describe a transition used to trigger an action list + + + Description + + voidswf_oncondition + inttransition + + + The swf_oncondition function describes a + transition that will trigger an action list. There are several + types of possible transitions, the following are for buttons + defined as TYPE_MENUBUTTON: + + + + IdletoOverUp + + + + + OverUptoIdle + + + + + OverUptoOverDown + + + + + OverDowntoOverUp + + + + + IdletoOverDown + + + + + OutDowntoIdle + + + + + MenuEnter (IdletoOverUp|IdletoOverDown) + + + + + MenuExit (OverUptoIdle|OverDowntoIdle) + + + + For TYPE_PUSHBUTTON there are the following options: + + + + IdletoOverUp + + + + + OverUptoIdle + + + + + OverUptoOverDown + + + + + OverDowntoOverUp + + + + + OverDowntoOutDown + + + + + OutDowntoOverDown + + + + + OutDowntoIdle + + + + + ButtonEnter (IdletoOverUp|OutDowntoOverDown) + + + + + ButtonExit (OverUptoIdle|OverDowntoOutDown) + + + + + + + - - - swf_openfile - Open a new Shockwave Flash file - - - Description - - voidswf_openfile - stringfilename - floatwidth - floatheight - floatframerate - floatr - floatg - floatb - - - The swf_openfile function opens a new file - named filename with a width of - width and a height of - height a frame rate of - framerate and background with a red color - of r a green color of - g and a blue color of - b. - - - The swf_openfile must be the first function - you call, otherwise your script will cause a segfault. If you - want to send your output to the screen make the filename: - "php://stdout" (support for this is in 4.0.1 and up). - - - + + + swf_openfile + Open a new Shockwave Flash file + + + Description + + voidswf_openfile + stringfilename + floatwidth + floatheight + floatframerate + floatr + floatg + floatb + + + The swf_openfile function opens a new file + named filename with a width of + width and a height of + height a frame rate of + framerate and background with a red color + of r a green color of + g and a blue color of + b. + + + The swf_openfile must be the first function + you call, otherwise your script will cause a segfault. If you + want to send your output to the screen make the filename: + "php://stdout" (support for this is in 4.0.1 and up). + + + + - - - swf_ortho - - Defines an orthographic mapping of user coordinates onto the - current viewport - - - - Description - - voidswf_ortho - floatxmin - floatxmax - floatymin - floatymax - floatzmin - floatzmax - - - The swf_ortho function defines an orthographic - mapping of user coordinates onto the current viewport. - - - + + + swf_ortho + Defines an orthographic mapping of user coordinates onto the current viewport + + + Description + + voidswf_ortho + floatxmin + floatxmax + floatymin + floatymax + floatzmin + floatzmax + + + The swf_ortho function defines an orthographic + mapping of user coordinates onto the current viewport. + + + + - - - swf_ortho2 - - Defines 2D orthographic mapping of user coordinates onto the - current viewport - - - - Description - - voidswf_ortho2 - floatxmin - floatxmax - floatymin - floatymax - - - The swf_ortho2 function defines a two - dimensional orthographic mapping of user coordinates onto the - current viewport, this defaults to one to one mapping of the area - of the Flash movie. If a perspective transformation is desired, - the swf_perspective function can be used. - - - + + + swf_ortho2 + Defines 2D orthographic mapping of user coordinates onto the current viewport + + + Description + + voidswf_ortho2 + floatxmin + floatxmax + floatymin + floatymax + + + The swf_ortho2 function defines a two + dimensional orthographic mapping of user coordinates onto the + current viewport, this defaults to one to one mapping of the area + of the Flash movie. If a perspective transformation is desired, + the swf_perspective function can be used. + + + + - - - swf_perspective - - Define a perspective projection transformation - - - - Description - - voidswf_perspective - floatfovy - floataspect - floatnear - floatfar - - - The swf_perspective function defines a - perspective projection transformation. The - fovy parameter is field-of-view angle in - the y direction. The aspect parameter - should be set to the aspect ratio of the viewport that is being - drawn onto. The near parameter is the - near clipping plane and the far parameter - is the far clipping plane. - - - - Various distortion artifacts may appear when performing a - perspective projection, this is because Flash players only have - a two dimensional matrix. Some are not to pretty. - - - - + + + swf_perspective + Define a perspective projection transformation + + + Description + + voidswf_perspective + floatfovy + floataspect + floatnear + floatfar + + + The swf_perspective function defines a + perspective projection transformation. The + fovy parameter is field-of-view angle in + the y direction. The aspect parameter + should be set to the aspect ratio of the viewport that is being + drawn onto. The near parameter is the + near clipping plane and the far parameter + is the far clipping plane. + + + + Various distortion artifacts may appear when performing a + perspective projection, this is because Flash players only have + a two dimensional matrix. Some are not to pretty. + + + + + - - - swf_placeobject - Place an object onto the screen - - - Description - - voidswf_placeobject - intobjid - intdepth - - - Places the object specified by objid in - the current frame at a depth of depth. - The objid parameter and the - depth must be between 1 and 65535. - - - This uses the current mulcolor (specified by - swf_mulcolor) and the current addcolor - (specified by swf_addcolor) to color the - object and it uses the current matrix to position the object. - - - - Full RGBA colors are supported. - - - - + + + swf_placeobject + Place an object onto the screen + + + Description + + voidswf_placeobject + intobjid + intdepth + + + Places the object specified by objid in + the current frame at a depth of depth. + The objid parameter and the + depth must be between 1 and 65535. + + + This uses the current mulcolor (specified by + swf_mulcolor) and the current addcolor + (specified by swf_addcolor) to color the + object and it uses the current matrix to position the object. + + + + Full RGBA colors are supported. + + + + + - - - swf_polarview - - Define the viewer's position with polar coordinates - - - - Description - - voidswf_polarview - floatdist - floatazimuth - floatincidence - floattwist - - - The swf_polarview function defines the - viewer's position in polar coordinates. The - dist parameter gives the distance between - the viewpoint to the world space origin. The - azimuth parameter defines the azimuthal - angle in the x,y coordinate plane, measured in distance from the - y axis. The incidence parameter defines - the angle of incidence in the y,z plane, measured in distance - from the z axis. The incidence angle is defined as the angle of - the viewport relative to the z axis. Finally the - twist specifies the amount that the - viewpoint is to be rotated about the line of sight using the - right hand rule. - - - + + + swf_polarview + Define the viewer's position with polar coordinates + + + Description + + voidswf_polarview + floatdist + floatazimuth + floatincidence + floattwist + + + The swf_polarview function defines the + viewer's position in polar coordinates. The + dist parameter gives the distance between + the viewpoint to the world space origin. The + azimuth parameter defines the azimuthal + angle in the x,y coordinate plane, measured in distance from the + y axis. The incidence parameter defines + the angle of incidence in the y,z plane, measured in distance + from the z axis. The incidence angle is defined as the angle of + the viewport relative to the z axis. Finally the + twist specifies the amount that the + viewpoint is to be rotated about the line of sight using the + right hand rule. + + + + - - - swf_popmatrix - - Restore a previous transformation matrix - - - - Description - - voidswf_popmatrix - - - - The swf_popmatrix function pushes the - current transformation matrix back onto the stack. - - - + + + swf_popmatrix + Restore a previous transformation matrix + + + Description + + voidswf_popmatrix + + + + The swf_popmatrix function pushes the + current transformation matrix back onto the stack. + + + + - - - swf_posround - - Enables or Disables the rounding of the translation when objects - are placed or moved - - - - Description - - voidswf_posround - intround - - - The swf_posround function enables or - disables the rounding of the translation when objects are placed - or moved, there are times when text becomes more readable because - rounding has been enabled. The round is - whether to enable rounding or not, if set to the value of 1, then - rounding is enabled, if set to 0 then rounding is disabled. - - - + + + swf_posround + Enables or Disables the rounding of the translation when objects are placed or moved + + + Description + + voidswf_posround + intround + + + The swf_posround function enables or + disables the rounding of the translation when objects are placed + or moved, there are times when text becomes more readable because + rounding has been enabled. The round is + whether to enable rounding or not, if set to the value of 1, then + rounding is enabled, if set to 0 then rounding is disabled. + + + + - - - swf_pushmatrix - - Push the current transformation matrix back unto the stack - - - - Description - - voidswf_pushmatrix - - - - The swf_pushmatrix function pushes the - current transformation matrix back onto the stack. - - - + + + swf_pushmatrix + Push the current transformation matrix back unto the stack + + + Description + + voidswf_pushmatrix + + + + The swf_pushmatrix function pushes the + current transformation matrix back onto the stack. + + + + - - - swf_removeobject - Remove an object - - - Description - - voidswf_removeobject - intdepth - - - Removes the object at the depth specified by - depth. - - - + + + swf_removeobject + Remove an object + + + Description + + voidswf_removeobject + intdepth + + + Removes the object at the depth specified by + depth. + + + + - - - swf_rotate - Rotate the current transformation - - - Description - - voidswf_rotate - floatangle - stringaxis - - - The swf_rotate rotates the current - transformation by the angle given by the - angle parameter around the axis given by - the axis parameter. Valid values for the - axis are 'x' (the x axis), 'y' (the y axis) or 'z' (the z axis). - - - + + + swf_rotate + Rotate the current transformation + + + Description + + voidswf_rotate + floatangle + stringaxis + + + The swf_rotate rotates the current + transformation by the angle given by the + angle parameter around the axis given by + the axis parameter. Valid values for the + axis are 'x' (the x axis), 'y' (the y axis) or 'z' (the z axis). + + + + - - - swf_scale - Scale the current transformation - - - Description - - voidswf_scale - floatx - floaty - floatz - - - The swf_scale scales the x coordinate of the - curve by the value of the x parameter, the - y coordinate of the curve by the value of the - y parameter, and the z coordinate of the - curve by the value of the z parameter. - - - + + + swf_scale + Scale the current transformation + + + Description + + voidswf_scale + floatx + floaty + floatz + + + The swf_scale scales the x coordinate of the + curve by the value of the x parameter, the + y coordinate of the curve by the value of the + y parameter, and the z coordinate of the + curve by the value of the z parameter. + + + + - - - swf_setfont - Change the current font - - - Description - - voidswf_setfont - intfontid - - - The swf_setfont sets the current font to the - value given by the fontid parameter. - - - + + + swf_setfont + Change the current font + + + Description + + voidswf_setfont + intfontid + + + The swf_setfont sets the current font to the + value given by the fontid parameter. + + + + - - - swf_setframe - Switch to a specified frame - - - Description - - voidswf_setframe - intframenumber - - - The swf_setframe changes the active frame to - the frame specified by framenumber. - - - + + + swf_setframe + Switch to a specified frame + + + Description + + voidswf_setframe + intframenumber + + + The swf_setframe changes the active frame to + the frame specified by framenumber. + + + + - - - swf_shapearc - Draw a circular arc - - - Description - - voidswf_shapearc - floatx - floaty - floatr - floatang1 - floatang2 - - - The swf_shapearc function draws a circular - arc from angle A given by the ang1 - parameter to angle B given by the ang2 - parameter. The center of the circle has an x coordinate given by - the x parameter and a y coordinate given - by the y, the radius of the circle is - given by the r parameter. - - - + + + swf_shapearc + Draw a circular arc + + + Description + + voidswf_shapearc + floatx + floaty + floatr + floatang1 + floatang2 + + + The swf_shapearc function draws a circular + arc from angle A given by the ang1 + parameter to angle B given by the ang2 + parameter. The center of the circle has an x coordinate given by + the x parameter and a y coordinate given + by the y, the radius of the circle is + given by the r parameter. + + + + - - - swf_shapecurveto - - Draw a quadratic bezier curve between two points - - - - Description - - voidswf_shapecurveto - floatx1 - floaty1 - floatx2 - floaty2 - - - The swf_shapecurveto function draws a - quadratic bezier curve from the current location, though the x - coordinate given by x1 and the y - coordinate given by y1 to the x - coordinate given by x2 and the y coordinate - given by y2. The current position is then - set to the x,y coordinates given by the x2 and - y2 parameters - - - + + + swf_shapecurveto + Draw a quadratic bezier curve between two points + + + Description + + voidswf_shapecurveto + floatx1 + floaty1 + floatx2 + floaty2 + + + The swf_shapecurveto function draws a + quadratic bezier curve from the current location, though the x + coordinate given by x1 and the y + coordinate given by y1 to the x + coordinate given by x2 and the y coordinate + given by y2. The current position is then + set to the x,y coordinates given by the x2 and + y2 parameters + + + + - - - swf_shapecurveto3 - Draw a cubic bezier curve - - - Description - - voidswf_shapecurveto3 - floatx1 - floaty1 - floatx2 - floaty2 - floatx3 - floaty3 - - - Draw a cubic bezier curve using the x,y coordinate pairs - x1, y1 and - x2,y2 as off curve - control points and the x,y coordinate - x3, y3 as an - endpoint. The current position is then set to the x,y coordinate - pair given by - x3,y3. - - - + + + swf_shapecurveto3 + Draw a cubic bezier curve + + + Description + + voidswf_shapecurveto3 + floatx1 + floaty1 + floatx2 + floaty2 + floatx3 + floaty3 + + + Draw a cubic bezier curve using the x,y coordinate pairs + x1, y1 and + x2,y2 as off curve + control points and the x,y coordinate + x3, y3 as an + endpoint. The current position is then set to the x,y coordinate + pair given by + x3,y3. + + + + - - - swf_shapefillbitmapclip - - Set current fill mode to clipped bitmap - - - - Description - - voidswf_shapefillbitmapclip - intbitmapid - - - Sets the fill to bitmap clipped, empty spaces will be filled by - the bitmap given by the bitmapid - parameter. - - - + + + swf_shapefillbitmapclip + Set current fill mode to clipped bitmap + + + Description + + voidswf_shapefillbitmapclip + intbitmapid + + + Sets the fill to bitmap clipped, empty spaces will be filled by + the bitmap given by the bitmapid + parameter. + + + + - - - swf_shapefillbitmaptile - - Set current fill mode to tiled bitmap - - - - Description - - voidswf_shapefillbitmaptile - intbitmapid - - - Sets the fill to bitmap tile, empty spaces will be filled by the - bitmap given by the bitmapid parameter - (tiled). - - - + + + swf_shapefillbitmaptile + Set current fill mode to tiled bitmap + + + Description + + voidswf_shapefillbitmaptile + intbitmapid + + + Sets the fill to bitmap tile, empty spaces will be filled by the + bitmap given by the bitmapid parameter + (tiled). + + + + - - - swf_shapefilloff - Turns off filling - - - Description - - voidswf_shapefilloff - - - - The swf_shapefilloff function turns off - filling for the current shape. - - - + + + swf_shapefilloff + Turns off filling + + + Description + + voidswf_shapefilloff + + + + The swf_shapefilloff function turns off + filling for the current shape. + + + + - - - swf_shapefillsolid - - Set the current fill style to the specified color - - - - Description - - voidswf_shapefillsolid - floatr - floatg - floatb - floata - - - The swf_shapefillsolid function sets the - current fill style to solid, and then sets the fill color to the - values of the rgba parameters. - - - + + + swf_shapefillsolid + Set the current fill style to the specified color + + + Description + + voidswf_shapefillsolid + floatr + floatg + floatb + floata + + + The swf_shapefillsolid function sets the + current fill style to solid, and then sets the fill color to the + values of the rgba parameters. + + + + - - - swf_shapelinesolid - Set the current line style - - - Description - - voidswf_shapelinesolid - floatr - floatg - floatb - floata - floatwidth - - - The swf_shapelinesolid function sets the - current line style to the color of the - rgba parameters and width to the - width parameter. If 0.0 is given as a - width then no lines are drawn. - - - + + + swf_shapelinesolid + Set the current line style + + + Description + + voidswf_shapelinesolid + floatr + floatg + floatb + floata + floatwidth + + + The swf_shapelinesolid function sets the + current line style to the color of the + rgba parameters and width to the + width parameter. If 0.0 is given as a + width then no lines are drawn. + + + + - - - swf_shapelineto - Draw a line - - - Description - - voidswf_shapelineto - floatx - floaty - - - The swf_shapelineto draws a line to the x,y - coordinates given by the x parameter & the - y parameter. The current position is then - set to the x,y parameters. - - - + + + swf_shapelineto + Draw a line + + + Description + + voidswf_shapelineto + floatx + floaty + + + The swf_shapelineto draws a line to the x,y + coordinates given by the x parameter & the + y parameter. The current position is then + set to the x,y parameters. + + + + - - - swf_shapemoveto - Move the current position - - - Description - - voidswf_shapemoveto - floatx - floaty - - - The swf_shapemoveto function moves the - current position to the x coordinate given by the - x parameter and the y position given by - the y parameter. - - - + + + swf_shapemoveto + Move the current position + + + Description + + voidswf_shapemoveto + floatx + floaty + + + The swf_shapemoveto function moves the + current position to the x coordinate given by the + x parameter and the y position given by + the y parameter. + + + + - - - swf_showframe - Display the current frame - - - Description - - voidswf_showframe - - - - The swf_showframe function will output the current frame. - - - + + + swf_showframe + Display the current frame + + + Description + + voidswf_showframe + + + + The swf_showframe function will output the current frame. + + + + - - - swf_startbutton - Start the definition of a button - - - Description - - voidswf_startbutton - intobjid - inttype - - - The swf_startbutton function starts off the - definition of a button. The type - parameter can either be TYPE_MENUBUTTON or TYPE_PUSHBUTTON. The - TYPE_MENUBUTTON constant allows the focus to travel from the - button when the mouse is down, TYPE_PUSHBUTTON does not allow the - focus to travel when the mouse is down. - - - + + + swf_startbutton + Start the definition of a button + + + Description + + voidswf_startbutton + intobjid + inttype + + + The swf_startbutton function starts off the + definition of a button. The type + parameter can either be TYPE_MENUBUTTON or TYPE_PUSHBUTTON. The + TYPE_MENUBUTTON constant allows the focus to travel from the + button when the mouse is down, TYPE_PUSHBUTTON does not allow the + focus to travel when the mouse is down. + + + + - - - swf_startdoaction - - Start a description of an action list for the current frame - - - - Description - - voidswf_startdoaction - - - - The swf_startdoaction function starts the - description of an action list for the current frame. This must - be called before actions are defined for the current frame. - - - + + + swf_startdoaction + Start a description of an action list for the current frame + + + Description + + voidswf_startdoaction + + + + The swf_startdoaction function starts the + description of an action list for the current frame. This must + be called before actions are defined for the current frame. + + + + - - - swf_startshape - Start a complex shape - - - Description - - voidswf_startshape - intobjid - - - The swf_startshape function starts a complex - shape, with an object id given by the - objid parameter. - - - + + + swf_startshape + Start a complex shape + + + Description + + voidswf_startshape + intobjid + + + The swf_startshape function starts a complex + shape, with an object id given by the + objid parameter. + + + + - - - swf_startsymbol - Define a symbol - - - Description - - voidswf_startsymbol - intobjid - - - Define an object id as a symbol. Symbols are tiny flash movies - that can be played simultaneously. The - objid parameter is the object id you want - to define as a symbol. - - - + + + swf_startsymbol + Define a symbol + + + Description + + voidswf_startsymbol + intobjid + + + Define an object id as a symbol. Symbols are tiny flash movies + that can be played simultaneously. The + objid parameter is the object id you want + to define as a symbol. + + + + - - - swf_textwidth - Get the width of a string - - - Description - - floatswf_textwidth - stringstr - - - The swf_textwidth function gives the width - of the string, str, in pixels, using the - current font and font size. - - - + + + swf_textwidth + Get the width of a string + + + Description + + floatswf_textwidth + stringstr + + + The swf_textwidth function gives the width + of the string, str, in pixels, using the + current font and font size. + + + + - - - swf_translate - Translate the current transformations - - - Description - - voidswf_translate - floatx - floaty - floatz - - - The swf_translate function translates the - current transformation by the x, - y, and z values - given. - - - + + + swf_translate + Translate the current transformations + + + Description + + voidswf_translate + floatx + floaty + floatz + + + The swf_translate function translates the + current transformation by the x, + y, and z values + given. + + + + - - - swf_viewport - Select an area for future drawing - - - Description - - voidswf_viewport - floatxmin - floatxmax - floatymin - floatymax - - - The swf_viewport function selects an area - for future drawing for xmin to - xmax and ymin to - ymax, if this function is not called the - area defaults to the size of the screen. - - - + + + swf_viewport + Select an area for future drawing + + + Description + + voidswf_viewport + floatxmin + floatxmax + floatymin + floatymax + + + The swf_viewport function selects an area + for future drawing for xmin to + xmax and ymin to + ymax, if this function is not called the + area defaults to the size of the screen. + + +