From a3af373ef18adc06f3ae403e5a43cf5b155461ca Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sat, 3 Feb 2007 18:55:13 +0000 Subject: [PATCH] ref.swf: switch to new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228897 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/swf/functions/swf-actiongeturl.xml | 44 +++- .../swf/functions/swf-actiongotoframe.xml | 31 ++- .../swf/functions/swf-actiongotolabel.xml | 31 ++- .../swf/functions/swf-actionnextframe.xml | 15 +- reference/swf/functions/swf-actionplay.xml | 15 +- .../swf/functions/swf-actionprevframe.xml | 15 +- .../swf/functions/swf-actionsettarget.xml | 34 ++- reference/swf/functions/swf-actionstop.xml | 16 +- .../swf/functions/swf-actiontogglequality.xml | 15 +- .../swf/functions/swf-actionwaitforframe.xml | 39 +++- .../swf/functions/swf-addbuttonrecord.xml | 73 ++++-- reference/swf/functions/swf-addcolor.xml | 80 +++++-- reference/swf/functions/swf-closefile.xml | 43 +++- reference/swf/functions/swf-definebitmap.xml | 43 +++- reference/swf/functions/swf-definefont.xml | 45 +++- reference/swf/functions/swf-defineline.xml | 79 ++++++- reference/swf/functions/swf-definepoly.xml | 66 +++++- reference/swf/functions/swf-definerect.xml | 82 ++++++- reference/swf/functions/swf-definetext.xml | 54 ++++- reference/swf/functions/swf-endbutton.xml | 15 +- reference/swf/functions/swf-enddoaction.xml | 15 +- reference/swf/functions/swf-endshape.xml | 15 +- reference/swf/functions/swf-endsymbol.xml | 18 +- reference/swf/functions/swf-fontsize.xml | 36 ++- reference/swf/functions/swf-fontslant.xml | 35 ++- reference/swf/functions/swf-fonttracking.xml | 31 ++- reference/swf/functions/swf-getbitmapinfo.xml | 36 ++- reference/swf/functions/swf-getfontinfo.xml | 21 +- reference/swf/functions/swf-getframe.xml | 16 +- reference/swf/functions/swf-labelframe.xml | 34 ++- reference/swf/functions/swf-lookat.xml | 90 ++++++-- reference/swf/functions/swf-modifyobject.xml | 56 +++-- reference/swf/functions/swf-mulcolor.xml | 80 +++++-- reference/swf/functions/swf-nextid.xml | 15 +- reference/swf/functions/swf-oncondition.xml | 216 ++++++++++-------- reference/swf/functions/swf-openfile.xml | 121 ++++++++-- reference/swf/functions/swf-ortho.xml | 69 +++++- reference/swf/functions/swf-ortho2.xml | 63 ++++- reference/swf/functions/swf-perspective.xml | 64 +++++- reference/swf/functions/swf-placeobject.xml | 56 +++-- reference/swf/functions/swf-polarview.xml | 72 ++++-- reference/swf/functions/swf-popmatrix.xml | 18 +- reference/swf/functions/swf-posround.xml | 41 +++- reference/swf/functions/swf-pushmatrix.xml | 18 +- reference/swf/functions/swf-removeobject.xml | 34 ++- reference/swf/functions/swf-rotate.xml | 48 +++- reference/swf/functions/swf-scale.xml | 54 ++++- reference/swf/functions/swf-setfont.xml | 31 ++- reference/swf/functions/swf-setframe.xml | 34 ++- reference/swf/functions/swf-shapearc.xml | 71 +++++- reference/swf/functions/swf-shapecurveto.xml | 69 +++++- reference/swf/functions/swf-shapecurveto3.xml | 84 ++++++- .../swf/functions/swf-shapefillbitmapclip.xml | 36 ++- .../swf/functions/swf-shapefillbitmaptile.xml | 34 ++- reference/swf/functions/swf-shapefilloff.xml | 18 +- .../swf/functions/swf-shapefillsolid.xml | 60 ++++- .../swf/functions/swf-shapelinesolid.xml | 69 +++++- reference/swf/functions/swf-shapelineto.xml | 45 +++- reference/swf/functions/swf-shapemoveto.xml | 44 +++- reference/swf/functions/swf-showframe.xml | 17 +- reference/swf/functions/swf-startbutton.xml | 51 ++++- reference/swf/functions/swf-startdoaction.xml | 20 +- reference/swf/functions/swf-startshape.xml | 35 ++- reference/swf/functions/swf-startsymbol.xml | 37 ++- reference/swf/functions/swf-textwidth.xml | 36 ++- reference/swf/functions/swf-translate.xml | 52 ++++- reference/swf/functions/swf-viewport.xml | 54 ++++- 67 files changed, 2477 insertions(+), 627 deletions(-) diff --git a/reference/swf/functions/swf-actiongeturl.xml b/reference/swf/functions/swf-actiongeturl.xml index 159b05eb49..82629a665b 100644 --- a/reference/swf/functions/swf-actiongeturl.xml +++ b/reference/swf/functions/swf-actiongeturl.xml @@ -1,22 +1,52 @@ - - + swf_actiongeturl Get a URL from a Shockwave Flash movie - - Description + + + &reftitle.description; voidswf_actiongeturl stringurl stringtarget - The swf_actiongeturl function gets the URL - specified by the parameter url with the - target target. + Gets the URL specified by the parameter url with + the given target. + + + + + &reftitle.parameters; + + + + url + + + The URL, as a string. + + + + + target + + + The target, as a string. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-actiongotoframe.xml b/reference/swf/functions/swf-actiongotoframe.xml index 9cc78ebefc..b00b22abeb 100644 --- a/reference/swf/functions/swf-actiongotoframe.xml +++ b/reference/swf/functions/swf-actiongotoframe.xml @@ -1,13 +1,13 @@ - - + swf_actiongotoframe Play a frame and then stop - - Description + + + &reftitle.description; voidswf_actiongotoframe intframenumber @@ -18,6 +18,29 @@ it, and then stop. + + + &reftitle.parameters; + + + + framenumber + + + The frame number. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + swf_actiongotolabel Display a frame with the specified label - - Description + + + &reftitle.description; voidswf_actiongotolabel stringlabel @@ -18,6 +18,29 @@ label parameter and then stops. + + + &reftitle.parameters; + + + + label + + + The frame label. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + swf_actionnextframe Go forward one frame - - Description + + + &reftitle.description; voidswf_actionnextframe @@ -16,6 +16,13 @@ Go forward one frame. + + + &reftitle.returnvalues; + + &return.void; + + - + swf_actionplay Start playing the flash movie from the current frame - - Description + + + &reftitle.description; voidswf_actionplay @@ -16,6 +16,13 @@ Start playing the flash movie from the current frame. + + + &reftitle.returnvalues; + + &return.void; + + - + swf_actionprevframe Go backwards one frame - - Description + + + &reftitle.description; voidswf_actionprevframe @@ -16,6 +16,13 @@ &warn.undocumented.func; + + + &reftitle.returnvalues; + + &return.void; + + - + swf_actionsettarget Set the context for actions - - Description + + + &reftitle.description; voidswf_actionsettarget stringtarget - The swf_actionsettarget function sets the - context for all actions. You can use this to control other flash + Sets the context for all actions. You can use this to control other flash movies that are currently playing. + + + &reftitle.parameters; + + + + target + + + The target, as a string. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + swf_actionstop Stop playing the flash movie at the current frame - - Description + + + &reftitle.description; voidswf_actionstop @@ -16,6 +16,14 @@ Stop playing the flash movie at the current frame. + + + &reftitle.returnvalues; + + &return.void; + + + - + swf_actiontogglequality Toggle between low and high quality - - Description + + + &reftitle.description; voidswf_actiontogglequality @@ -16,6 +16,13 @@ Toggle the flash movie between high and low quality. + + + &reftitle.returnvalues; + + &return.void; + + - + swf_actionwaitforframe Skip actions if a frame has not been loaded - - Description + + + &reftitle.description; voidswf_actionwaitforframe intframenumber @@ -22,6 +22,37 @@ for "Loading..." type animations. + + + &reftitle.parameters; + + + + framenumber + + + The frame number. + + + + + skipcount + + + The number of actions to skip. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + swf_addbuttonrecord Controls location, appearance and active area of the current button - - Description + + + &reftitle.description; voidswf_addbuttonrecord intstates @@ -15,19 +15,59 @@ 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. + Allow you to define the specifics of using a button. + + + + + &reftitle.parameters; + + + + states + + + Defines what states the button can have, these can be any or all of + the following constants: BSHitTest, + BSDown, BSOver or + BSUp. + + + + + shapeid + + + The second parameter, the shapeid is the look + of the button, this is usually the object id of the shape of the + button. + + + + + depth + + + This parameter is the placement of the button in the current frame. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.examples; + - - <function>swf_addbuttonrecord</function> example - + <function>swf_addbuttonrecord</function> example + - + swf_addcolor Set the global add color to the rgba value specified - - Description + + + &reftitle.description; voidswf_addcolor floatr @@ -16,21 +16,65 @@ 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. + Sets the global add color to the specified color. This color is then + implicitly used by the swf_placeobject, + swf_modifyobject and + swf_addbuttonrecord functions. + + + The color of the object will be add by the given values when the object is + written to the screen. + + + + + &reftitle.parameters; + + + + r + + + Red value + + + + + g + + + Green value + + + + + b + + + Blue value + + + + + a + + + Alpha value + + + + + + + These parameters can be either positive or negative. + + + + + &reftitle.returnvalues; + + &return.void; - - - The rgba values can be either positive or - negative. - - diff --git a/reference/swf/functions/swf-closefile.xml b/reference/swf/functions/swf-closefile.xml index 5562528f2b..51d5d7db54 100644 --- a/reference/swf/functions/swf-closefile.xml +++ b/reference/swf/functions/swf-closefile.xml @@ -1,23 +1,50 @@ - - + swf_closefile Close the current Shockwave Flash file - - Description + + + &reftitle.description; - voidswf_closefile + mixedswf_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. + swf_openfile function. + + + + &reftitle.parameters; + + + + return_file + + + If set then the contents of the SWF file are returned from the + function. + + + + + + + + + &reftitle.returnvalues; + + If return_file is provided returns the SWF + contents, otherwise returns &null;. + + + + + &reftitle.examples; diff --git a/reference/swf/functions/swf-definebitmap.xml b/reference/swf/functions/swf-definebitmap.xml index c715bc26a2..f6d33cacf0 100644 --- a/reference/swf/functions/swf-definebitmap.xml +++ b/reference/swf/functions/swf-definebitmap.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.swf-definebitmap"> <refnamediv> <refname>swf_definebitmap</refname> <refpurpose>Define a bitmap</refpurpose> </refnamediv> - <refsect1> - <title>Description + + + &reftitle.description; voidswf_definebitmap intobjid @@ -15,8 +15,39 @@ 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. + bitmap given an image. + + + + + &reftitle.parameters; + + + + objid + + + An SWF object id. + + + + + image_name + + + A GIF, JPEG, RGB or FI image. The image will be converted into a Flash + JPEG or Flash color map format. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-definefont.xml b/reference/swf/functions/swf-definefont.xml index d429c700a0..218de670e7 100644 --- a/reference/swf/functions/swf-definefont.xml +++ b/reference/swf/functions/swf-definefont.xml @@ -1,26 +1,55 @@ - - + swf_definefont Defines a font - - Description + + + &reftitle.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 + The swf_definefont function defines a font parameter + and gives it the specified id. It then sets the font given by fontname to the current font. + + + &reftitle.parameters; + + + + fontid + + + The id to be given to the font. + + + + + fontname + + + The font so be set as current font. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + swf_defineline Define a line - - Description + + + &reftitle.description; voidswf_defineline intobjid @@ -18,13 +18,70 @@ 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. + Defines a line. + + + + + &reftitle.parameters; + + + + objid + + + The object id. + + + + + x1 + + + x-coordinate of start point. + + + + + y1 + + + y-coordinate of start point. + + + + + x2 + + + x-coordinate of end point. + + + + + y2 + + + y-coordinate of end point. + + + + + width + + + The line width. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-definepoly.xml b/reference/swf/functions/swf-definepoly.xml index a78d6cb0c5..03c8e5e6d9 100644 --- a/reference/swf/functions/swf-definepoly.xml +++ b/reference/swf/functions/swf-definepoly.xml @@ -1,13 +1,13 @@ - - + swf_definepoly Define a polygon - - Description + + + &reftitle.description; voidswf_definepoly intobjid @@ -16,14 +16,56 @@ 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. + Defines a polygon given an array of x, y coordinates. + + + + + &reftitle.parameters; + + + + objid + + + The object id. + + + + + coords + + + An array of x, y coordinates. + + + + + npoints + + + The number of overall points that are contained in the array given by + coords + + + + + width + + + The width of the polygon's border, if set to 0.0 the polygon is + filled. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-definerect.xml b/reference/swf/functions/swf-definerect.xml index 2236a71f45..b9890b8d00 100644 --- a/reference/swf/functions/swf-definerect.xml +++ b/reference/swf/functions/swf-definerect.xml @@ -1,13 +1,13 @@ - - + swf_definerect Define a rectangle - - Description + + + &reftitle.description; voidswf_definerect intobjid @@ -18,14 +18,72 @@ 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. + Defines a rectangle with an upper left hand coordinate and a lower right + hand coordinate. + + + + + &reftitle.parameters; + + + + objid + + + The object id. + + + + + x1 + + + x-coordinate of upper left point. + + + + + y1 + + + y-coordinate of upper left point. + + + + + x2 + + + x-coordinate of lower right point. + + + + + y2 + + + y-coordinate of lower right point. + + + + + width + + + Width of the rectangles border, if the width is 0.0 then the rectangle + is filled. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-definetext.xml b/reference/swf/functions/swf-definetext.xml index 4376e19ace..f9f037918a 100644 --- a/reference/swf/functions/swf-definetext.xml +++ b/reference/swf/functions/swf-definetext.xml @@ -1,13 +1,13 @@ - - + swf_definetext Define a text string - - Description + + + &reftitle.description; voidswf_definetext intobjid @@ -15,11 +15,47 @@ 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. + Defines a text string using the current font and font size. + + + + + &reftitle.parameters; + + + + objid + + + The object id. + + + + + str + + + The text, as a string. + + + + + docenter + + + The docenter is where the word is centered, if + docenter is 1, then the word is centered in x. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-endbutton.xml b/reference/swf/functions/swf-endbutton.xml index 67777e87a7..769c98c341 100644 --- a/reference/swf/functions/swf-endbutton.xml +++ b/reference/swf/functions/swf-endbutton.xml @@ -1,13 +1,13 @@ - - + swf_endbutton End the definition of the current button - - Description + + + &reftitle.description; voidswf_endbutton @@ -17,6 +17,13 @@ definition of the current button. + + + &reftitle.returnvalues; + + &return.void; + + - + swf_enddoaction End the current action - - Description + + + &reftitle.description; voidswf_enddoaction @@ -17,6 +17,13 @@ swf_startdoaction function. + + + &reftitle.returnvalues; + + &return.void; + + - + swf_endshape Completes the definition of the current shape - - Description + + + &reftitle.description; voidswf_endshape @@ -17,6 +17,13 @@ the current shape. + + + &reftitle.returnvalues; + + &return.void; + + - + swf_endsymbol End the definition of a symbol - - Description + + + &reftitle.description; voidswf_endsymbol - The swf_endsymbol function ends the - definition of a symbol that was started by the + Ends the definition of a symbol that was started by the swf_startsymbol function. + + + &reftitle.returnvalues; + + &return.void; + + - + swf_fontsize Change the font size - - Description + + + &reftitle.description; voidswf_fontsize floatsize - The swf_fontsize function changes the font - size to the value given by the size - parameter. + Changes the font size to the value given by the + size parameter. + + + + + &reftitle.parameters; + + + + size + + + The font size, as an integer. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-fontslant.xml b/reference/swf/functions/swf-fontslant.xml index 479832f416..03392adca7 100644 --- a/reference/swf/functions/swf-fontslant.xml +++ b/reference/swf/functions/swf-fontslant.xml @@ -1,21 +1,44 @@ - - + swf_fontslant Set the font slant - - Description + + + &reftitle.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. + slant parameter. + + + + + &reftitle.parameters; + + + + slant + + + Positive values create a forward slant, negative values create a + negative slant. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-fonttracking.xml b/reference/swf/functions/swf-fonttracking.xml index b2dc0c87c9..2c3465c7e2 100644 --- a/reference/swf/functions/swf-fonttracking.xml +++ b/reference/swf/functions/swf-fonttracking.xml @@ -1,13 +1,13 @@ - - + swf_fonttracking Set the current font tracking - - Description + + + &reftitle.description; voidswf_fonttracking floattracking @@ -20,6 +20,29 @@ letters. + + + &reftitle.parameters; + + + + tracking + + + The font tracking. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + swf_getbitmapinfo Get information about a bitmap - - Description + + + &reftitle.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: + Returns information about a bitmap. + + + + + &reftitle.parameters; + + + + bitmapid + + + The bitmap id. + + + + + + + + + &reftitle.returnvalues; + + Returns an array with the following elements: diff --git a/reference/swf/functions/swf-getfontinfo.xml b/reference/swf/functions/swf-getfontinfo.xml index 0b6012aad8..e334400f76 100644 --- a/reference/swf/functions/swf-getfontinfo.xml +++ b/reference/swf/functions/swf-getfontinfo.xml @@ -1,20 +1,27 @@ - - + swf_getfontinfo - The height in pixels of a capital A and a lowercase x + Gets font information - - Description + + + &reftitle.description; arrayswf_getfontinfo - The swf_getfontinfo function returns an - associative array with the following parameters: + Gets information about the font by giving the height in pixels of a + capital A and a lowercase x. + + + + + &reftitle.returnvalues; + + Returns an associative array with the following parameters: diff --git a/reference/swf/functions/swf-getframe.xml b/reference/swf/functions/swf-getframe.xml index 731f0ea30f..64b2b507eb 100644 --- a/reference/swf/functions/swf-getframe.xml +++ b/reference/swf/functions/swf-getframe.xml @@ -1,13 +1,13 @@ - - + swf_getframe Get the frame number of the current frame - - Description + + + &reftitle.description; intswf_getframe @@ -17,6 +17,14 @@ the current frame. + + + &reftitle.returnvalues; + + Returns the current frame number, as an integer. + + + - + swf_labelframe Label the current frame - - Description + + + &reftitle.description; voidswf_labelframe stringname - Label the current frame with the name given by the - name parameter. + Labels the current frame with the given name. + + + + + &reftitle.parameters; + + + + name + + + The frame label. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-lookat.xml b/reference/swf/functions/swf-lookat.xml index d96ae34799..03d9f1ae8e 100644 --- a/reference/swf/functions/swf-lookat.xml +++ b/reference/swf/functions/swf-lookat.xml @@ -1,13 +1,13 @@ - - + swf_lookat Define a viewing transformation - - Description + + + &reftitle.description; voidswf_lookat floatview_x @@ -19,15 +19,79 @@ 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. + Defines a viewing transformation by giving the viewing position and the + coordinates of a reference point in the scene. + + + + + &reftitle.parameters; + + + + view_x + + + x-coordinate for the viewing position + + + + + view_y + + + y-coordinate for the viewing position + + + + + view_z + + + z-coordinate for the viewing position + + + + + reference_x + + + x-coordinate for the reference point + + + + + reference_y + + + y-coordinate for the reference point + + + + + reference_z + + + z-coordinate for the reference point + + + + + twist + + + Controls the rotation along with viewer's z axis. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-modifyobject.xml b/reference/swf/functions/swf-modifyobject.xml index 06847d4f02..717bd638a7 100644 --- a/reference/swf/functions/swf-modifyobject.xml +++ b/reference/swf/functions/swf-modifyobject.xml @@ -1,13 +1,13 @@ - - + swf_modifyobject Modify an object - - Description + + + &reftitle.description; voidswf_modifyobject intdepth @@ -15,17 +15,47 @@ 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). + depth. + + + + &reftitle.parameters; - 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. + + + depth + + + The depth, as an integer. + + + + + 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_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. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-mulcolor.xml b/reference/swf/functions/swf-mulcolor.xml index fd78044ba3..f6367f67d9 100644 --- a/reference/swf/functions/swf-mulcolor.xml +++ b/reference/swf/functions/swf-mulcolor.xml @@ -1,13 +1,13 @@ - - + swf_mulcolor Sets the global multiply color to the rgba value specified - - Description + + + &reftitle.description; voidswf_mulcolor floatr @@ -16,21 +16,65 @@ 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. + Sets the global multiply color to the given one. This color is then + implicitly used by the swf_placeobject, + swf_modifyobject and + swf_addbuttonrecord functions. + + + The color of the object will be multiplied by the given color values when + the object is written to the screen. + + + + + &reftitle.parameters; + + + + r + + + Red value + + + + + g + + + Green value + + + + + b + + + Blue value + + + + + a + + + Alpha value + + + + + + + These parameters can be either positive or negative. + + + + + &reftitle.returnvalues; + + &return.void; - - - The rgba values can be either positive or - negative. - - diff --git a/reference/swf/functions/swf-nextid.xml b/reference/swf/functions/swf-nextid.xml index fffef14d75..023b793dd1 100644 --- a/reference/swf/functions/swf-nextid.xml +++ b/reference/swf/functions/swf-nextid.xml @@ -1,13 +1,13 @@ - - + swf_nextid Returns the next free object id - - Description + + + &reftitle.description; intswf_nextid @@ -17,6 +17,13 @@ available object id. + + + &reftitle.returnvalues; + + Returns the id, as an integer. + + - + swf_oncondition Describe a transition used to trigger an action list - - Description + + + &reftitle.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) - - - + transition that will trigger an action list. + + + + + &reftitle.parameters; + + + + transition + + + 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) + + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-openfile.xml b/reference/swf/functions/swf-openfile.xml index 249c790f5d..67e23eedb2 100644 --- a/reference/swf/functions/swf-openfile.xml +++ b/reference/swf/functions/swf-openfile.xml @@ -1,13 +1,13 @@ - - + swf_openfile Open a new Shockwave Flash file - - Description + + + &reftitle.description; voidswf_openfile stringfilename @@ -19,22 +19,107 @@ 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). + Opens a new file. This must be the first function you call, otherwise your + script will not work. + + + &reftitle.parameters; + + + + filename + + + The path to the SWF file. If you want to send your output to the + screen, set this to php://stdout. + + + + + width + + + The movie width + + + + + height + + + The movie height + + + + + framerate + + + The frame rate. + + + + + r + + + Red value for the background. + + + + + g + + + Green value for the background. + + + + + b + + + Blue value for the background. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 4.0.1 + + Support for php://stdout was added. + + + + + + + + - + swf_ortho Defines an orthographic mapping of user coordinates onto the current viewport - - Description + + + &reftitle.description; voidswf_ortho floatxmin @@ -18,8 +18,65 @@ floatzmax - The swf_ortho function defines an orthographic - mapping of user coordinates onto the current viewport. + Defines an orthographic mapping of user coordinates onto the current + viewport. + + + + + &reftitle.parameters; + + + + xmin + + + + + + + xmax + + + + + + + ymin + + + + + + + ymax + + + + + + + zmin + + + + + + + zmax + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-ortho2.xml b/reference/swf/functions/swf-ortho2.xml index 8a6c6fa773..37a6804394 100644 --- a/reference/swf/functions/swf-ortho2.xml +++ b/reference/swf/functions/swf-ortho2.xml @@ -1,13 +1,13 @@ - - + swf_ortho2 Defines 2D orthographic mapping of user coordinates onto the current viewport - - Description + + + &reftitle.description; voidswf_ortho2 floatxmin @@ -16,11 +16,56 @@ 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. + 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, + swf_perspective can be used. + + + + + &reftitle.parameters; + + + + xmin + + + + + + + xmax + + + + + + + ymin + + + + + + + ymax + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-perspective.xml b/reference/swf/functions/swf-perspective.xml index e117f9a54c..176f2d3c80 100644 --- a/reference/swf/functions/swf-perspective.xml +++ b/reference/swf/functions/swf-perspective.xml @@ -1,13 +1,13 @@ - - + swf_perspective Define a perspective projection transformation - - Description + + + &reftitle.description; voidswf_perspective floatfovy @@ -16,14 +16,7 @@ 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. + Defines a perspective projection transformation. @@ -33,6 +26,53 @@ + + + &reftitle.parameters; + + + + fovy + + + A field-of-view angle in the y direction. + + + + + aspect + + + The aspect ratio of the viewport that is being drawn onto. + + + + + near + + + The near clipping plane. + + + + + far + + + The far clipping plane. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + swf_placeobject Place an object onto the screen - - Description + + + &reftitle.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. + Places the object in the current frame at a specified + depth. 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. + swf_mulcolor) and the current addcolor (specified by + swf_addcolor) to color the object and it uses the + current matrix to position the object. + + + + + &reftitle.parameters; + + + + objid + + + The object id. + + + + + depth + + + Must be between 1 and 65535. + + + + + + + + + &reftitle.returnvalues; + + &return.void; - - - Full RGBA colors are supported. - - diff --git a/reference/swf/functions/swf-polarview.xml b/reference/swf/functions/swf-polarview.xml index f4bd82ad5a..9b09fe042f 100644 --- a/reference/swf/functions/swf-polarview.xml +++ b/reference/swf/functions/swf-polarview.xml @@ -1,13 +1,13 @@ - - + swf_polarview Define the viewer's position with polar coordinates - - Description + + + &reftitle.description; voidswf_polarview floatdist @@ -17,18 +17,58 @@ 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. + viewer's position in polar coordinates. + + + + + &reftitle.parameters; + + + + dist + + + The distance between the viewpoint to the world space origin. + + + + + azimuth + + + Defines the azimuthal angle in the x,y coordinate plane, measured in + distance from the y axis. + + + + + incidence + + + 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. + + + + + twist + + + Specifies the amount that the viewpoint is to be rotated about the + line of sight using the right hand rule. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-popmatrix.xml b/reference/swf/functions/swf-popmatrix.xml index b423b8ef69..46b67d1429 100644 --- a/reference/swf/functions/swf-popmatrix.xml +++ b/reference/swf/functions/swf-popmatrix.xml @@ -1,20 +1,26 @@ - - + swf_popmatrix Restore a previous transformation matrix - - Description + + + &reftitle.description; voidswf_popmatrix - The swf_popmatrix function pushes the - current transformation matrix back onto the stack. + Pushes the current transformation matrix back onto the stack. + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-posround.xml b/reference/swf/functions/swf-posround.xml index 41dafcbf0d..265f5cb3fb 100644 --- a/reference/swf/functions/swf-posround.xml +++ b/reference/swf/functions/swf-posround.xml @@ -1,24 +1,45 @@ - - + swf_posround Enables or Disables the rounding of the translation when objects are placed or moved - - Description + + + &reftitle.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. + 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. + + + + + &reftitle.parameters; + + + + round + + + 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. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-pushmatrix.xml b/reference/swf/functions/swf-pushmatrix.xml index 69a8c6445e..9e65ebae32 100644 --- a/reference/swf/functions/swf-pushmatrix.xml +++ b/reference/swf/functions/swf-pushmatrix.xml @@ -1,20 +1,26 @@ - - + swf_pushmatrix Push the current transformation matrix back unto the stack - - Description + + + &reftitle.description; voidswf_pushmatrix - The swf_pushmatrix function pushes the - current transformation matrix back onto the stack. + Pushes the current transformation matrix back onto the stack. + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-removeobject.xml b/reference/swf/functions/swf-removeobject.xml index 573907c494..37cfb7f0eb 100644 --- a/reference/swf/functions/swf-removeobject.xml +++ b/reference/swf/functions/swf-removeobject.xml @@ -1,20 +1,42 @@ - - + swf_removeobject Remove an object - - Description + + + &reftitle.description; voidswf_removeobject intdepth - Removes the object at the depth specified by - depth. + Removes the object at the depth specified by depth. + + + + + &reftitle.parameters; + + + + depth + + + The depth, as an integer. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-rotate.xml b/reference/swf/functions/swf-rotate.xml index 17838b4942..76afcd4b1b 100644 --- a/reference/swf/functions/swf-rotate.xml +++ b/reference/swf/functions/swf-rotate.xml @@ -1,24 +1,54 @@ - - + swf_rotate Rotate the current transformation - - Description + + + &reftitle.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). + Rotates the current transformation by a given angle + around the given axis. + + + + + &reftitle.parameters; + + + + angle + + + The rotation angle. + + + + + axis + + + The axis. Valid values axis are x (the x axis), + y (the y axis) or z (the z + axis). + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-scale.xml b/reference/swf/functions/swf-scale.xml index cfbcac27f1..e556f864c1 100644 --- a/reference/swf/functions/swf-scale.xml +++ b/reference/swf/functions/swf-scale.xml @@ -1,13 +1,13 @@ - - + swf_scale Scale the current transformation - - Description + + + &reftitle.description; voidswf_scale floatx @@ -15,11 +15,47 @@ 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. + The swf_scale scales curve coordinates by the given + value. + + + + + &reftitle.parameters; + + + + x + + + x scale factor. + + + + + y + + + y scale factor. + + + + + z + + + z scale factor. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-setfont.xml b/reference/swf/functions/swf-setfont.xml index f22ef95661..056a2f4b4e 100644 --- a/reference/swf/functions/swf-setfont.xml +++ b/reference/swf/functions/swf-setfont.xml @@ -1,13 +1,13 @@ - - + swf_setfont Change the current font - - Description + + + &reftitle.description; voidswf_setfont intfontid @@ -17,6 +17,29 @@ value given by the fontid parameter. + + + &reftitle.parameters; + + + + fontid + + + The font identifier. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + swf_setframe Switch to a specified frame - - Description + + + &reftitle.description; voidswf_setframe intframenumber - The swf_setframe changes the active frame to - the frame specified by framenumber. + Changes the active frame to the specified on. + + + + + &reftitle.parameters; + + + + framenumber + + + The frame number to be set. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapearc.xml b/reference/swf/functions/swf-shapearc.xml index 2c8d496a03..c5cdd91309 100644 --- a/reference/swf/functions/swf-shapearc.xml +++ b/reference/swf/functions/swf-shapearc.xml @@ -1,13 +1,13 @@ - - + swf_shapearc Draw a circular arc - - Description + + + &reftitle.description; voidswf_shapearc floatx @@ -17,13 +17,62 @@ 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. + Draws a circular arc. + + + + + &reftitle.parameters; + + + + x + + + x-coordinate of the center. + + + + + y + + + y-coordinate of the center. + + + + + r + + + The arc radius. + + + + + ang1 + + + The start angle. + + + + + ang2 + + + The end angle. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapecurveto.xml b/reference/swf/functions/swf-shapecurveto.xml index 6dd105dd3c..c720e8718c 100644 --- a/reference/swf/functions/swf-shapecurveto.xml +++ b/reference/swf/functions/swf-shapecurveto.xml @@ -1,13 +1,13 @@ - - + swf_shapecurveto Draw a quadratic bezier curve between two points - - Description + + + &reftitle.description; voidswf_shapecurveto floatx1 @@ -16,14 +16,59 @@ 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 + Draws a quadratic bezier curve from the current location, though the + two given points. + + + The current position is then set to the point defined by the + x2 and y2 parameters. + + + + + &reftitle.parameters; + + + + x1 + + + x-coordinate of the first point. + + + + + y1 + + + y-coordinate of the first point. + + + + + x2 + + + x-coordinate of the second point. + + + + + y2 + + + y-coordinate of the second point. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapecurveto3.xml b/reference/swf/functions/swf-shapecurveto3.xml index bb68353336..1b6ee82f78 100644 --- a/reference/swf/functions/swf-shapecurveto3.xml +++ b/reference/swf/functions/swf-shapecurveto3.xml @@ -1,13 +1,13 @@ - - + swf_shapecurveto3 Draw a cubic bezier curve - - Description + + + &reftitle.description; voidswf_shapecurveto3 floatx1 @@ -18,14 +18,74 @@ 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. + Draw a cubic bezier curve using the given coordinates. + + + The current position is then set to the + x3,y3 coordinate. + + + + + &reftitle.parameters; + + + + x1 + + + x-coordinate of the first off curve control point. + + + + + y1 + + + y-coordinate of the first off curve control point. + + + + + x2 + + + x-coordinate of the second off curve control point. + + + + + y2 + + + y-coordinate of the second off curve control point. + + + + + x3 + + + x-coordinate of the endpoint. + + + + + y3 + + + y-coordinate of the endpoint. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapefillbitmapclip.xml b/reference/swf/functions/swf-shapefillbitmapclip.xml index f78e4ec7fc..236a6613b2 100644 --- a/reference/swf/functions/swf-shapefillbitmapclip.xml +++ b/reference/swf/functions/swf-shapefillbitmapclip.xml @@ -1,21 +1,43 @@ - - + swf_shapefillbitmapclip Set current fill mode to clipped bitmap - - Description + + + &reftitle.description; voidswf_shapefillbitmapclip intbitmapid - Sets the fill to bitmap clipped, empty spaces will be filled by - the bitmap given by the bitmapid - parameter. + Sets the fill to bitmap clipped, empty spaces will be filled by the + bitmap. + + + + + &reftitle.parameters; + + + + bitmapid + + + The bitmap id. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapefillbitmaptile.xml b/reference/swf/functions/swf-shapefillbitmaptile.xml index 7b26dc0872..5bba85cb3d 100644 --- a/reference/swf/functions/swf-shapefillbitmaptile.xml +++ b/reference/swf/functions/swf-shapefillbitmaptile.xml @@ -1,21 +1,43 @@ - - + swf_shapefillbitmaptile Set current fill mode to tiled bitmap - - Description + + + &reftitle.description; voidswf_shapefillbitmaptile intbitmapid Sets the fill to bitmap tile, empty spaces will be filled by the - bitmap given by the bitmapid parameter - (tiled). + bitmap. + + + + + &reftitle.parameters; + + + + bitmapid + + + The bitmap id. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapefilloff.xml b/reference/swf/functions/swf-shapefilloff.xml index fc53c6793d..28a8ee0a6f 100644 --- a/reference/swf/functions/swf-shapefilloff.xml +++ b/reference/swf/functions/swf-shapefilloff.xml @@ -1,20 +1,26 @@ - - + swf_shapefilloff Turns off filling - - Description + + + &reftitle.description; voidswf_shapefilloff - The swf_shapefilloff function turns off - filling for the current shape. + Turns off filling for the current shape. + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapefillsolid.xml b/reference/swf/functions/swf-shapefillsolid.xml index d1503f90e0..cf08beca15 100644 --- a/reference/swf/functions/swf-shapefillsolid.xml +++ b/reference/swf/functions/swf-shapefillsolid.xml @@ -1,13 +1,13 @@ - - + swf_shapefillsolid Set the current fill style to the specified color - - Description + + + &reftitle.description; voidswf_shapefillsolid floatr @@ -16,9 +16,55 @@ 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. + Sets the current fill style to solid, and then sets the fill color to the + given color. + + + + + &reftitle.parameters; + + + + r + + + Red value + + + + + g + + + Green value + + + + + b + + + Blue value + + + + + a + + + Alpha value + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapelinesolid.xml b/reference/swf/functions/swf-shapelinesolid.xml index 69db40c135..f3037967b1 100644 --- a/reference/swf/functions/swf-shapelinesolid.xml +++ b/reference/swf/functions/swf-shapelinesolid.xml @@ -1,13 +1,13 @@ - - + swf_shapelinesolid Set the current line style - - Description + + + &reftitle.description; voidswf_shapelinesolid floatr @@ -17,11 +17,62 @@ 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. + Sets the current line style to the given color and width. + + + + + &reftitle.parameters; + + + + r + + + Red value + + + + + g + + + Green value + + + + + b + + + Blue value + + + + + a + + + Alpha value + + + + + width + + + The line width. If 0.0 is given then no lines are drawn. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapelineto.xml b/reference/swf/functions/swf-shapelineto.xml index 3918e56b64..8324fa371a 100644 --- a/reference/swf/functions/swf-shapelineto.xml +++ b/reference/swf/functions/swf-shapelineto.xml @@ -1,23 +1,52 @@ - - + swf_shapelineto Draw a line - - Description + + + &reftitle.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. + Draws a line to the x and y + coordinates. The current position is then set to that point. + + + + + &reftitle.parameters; + + + + x + + + x-coordinate of the target. + + + + + y + + + y-coordinate of the target. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-shapemoveto.xml b/reference/swf/functions/swf-shapemoveto.xml index eb74e4d2a7..c791806b07 100644 --- a/reference/swf/functions/swf-shapemoveto.xml +++ b/reference/swf/functions/swf-shapemoveto.xml @@ -1,23 +1,51 @@ - - + swf_shapemoveto Move the current position - - Description + + + &reftitle.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. + Moves the current position to the given point. + + + + + &reftitle.parameters; + + + + x + + + x-coordinate of the target. + + + + + y + + + y-coordinate of the target. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-showframe.xml b/reference/swf/functions/swf-showframe.xml index be37374b65..ddcc3a99ac 100644 --- a/reference/swf/functions/swf-showframe.xml +++ b/reference/swf/functions/swf-showframe.xml @@ -1,19 +1,26 @@ - - + swf_showframe Display the current frame - - Description + + + &reftitle.description; voidswf_showframe - The swf_showframe function will output the current frame. + Outputs the current frame. + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-startbutton.xml b/reference/swf/functions/swf-startbutton.xml index 4dd2817461..90b3c5a48b 100644 --- a/reference/swf/functions/swf-startbutton.xml +++ b/reference/swf/functions/swf-startbutton.xml @@ -1,25 +1,56 @@ - - + swf_startbutton Start the definition of a button - - Description + + + &reftitle.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. + Starts the definition of a button. + + + + + &reftitle.parameters; + + + + objid + + + The object id. + + + + + type + + + 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. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-startdoaction.xml b/reference/swf/functions/swf-startdoaction.xml index 90489c239d..69986c8af5 100644 --- a/reference/swf/functions/swf-startdoaction.xml +++ b/reference/swf/functions/swf-startdoaction.xml @@ -1,21 +1,27 @@ - - + swf_startdoaction Start a description of an action list for the current frame - - Description + + + &reftitle.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. + Starts the description of an action list for the current frame. This + must be called before actions are defined for the current frame. + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-startshape.xml b/reference/swf/functions/swf-startshape.xml index 6a2e4edfc2..578a8055cb 100644 --- a/reference/swf/functions/swf-startshape.xml +++ b/reference/swf/functions/swf-startshape.xml @@ -1,21 +1,42 @@ - - + swf_startshape Start a complex shape - - Description + + + &reftitle.description; voidswf_startshape intobjid - The swf_startshape function starts a complex - shape, with an object id given by the - objid parameter. + Starts a complex shape. + + + + + &reftitle.parameters; + + + + objid + + + The object id. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-startsymbol.xml b/reference/swf/functions/swf-startsymbol.xml index e1503d80fa..60caad1d1e 100644 --- a/reference/swf/functions/swf-startsymbol.xml +++ b/reference/swf/functions/swf-startsymbol.xml @@ -1,22 +1,43 @@ - - + swf_startsymbol Define a symbol - - Description + + + &reftitle.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. + Defines an object id as a symbol. Symbols are tiny flash movies that can + be played simultaneously. + + + + + &reftitle.parameters; + + + + objid + + + The object id you want to define as a symbol. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-textwidth.xml b/reference/swf/functions/swf-textwidth.xml index 89abd9331f..1631c88e17 100644 --- a/reference/swf/functions/swf-textwidth.xml +++ b/reference/swf/functions/swf-textwidth.xml @@ -1,21 +1,43 @@ - - + swf_textwidth Get the width of a string - - Description + + + &reftitle.description; floatswf_textwidth stringstr - The swf_textwidth function gives the width - of the string, str, in pixels, using the - current font and font size. + Gives the width of the string in pixels, using the current font and font + size. + + + + + &reftitle.parameters; + + + + str + + + The string. + + + + + + + + + &reftitle.returnvalues; + + Returns the line width, as a float. diff --git a/reference/swf/functions/swf-translate.xml b/reference/swf/functions/swf-translate.xml index 0769bbf90f..23798514ef 100644 --- a/reference/swf/functions/swf-translate.xml +++ b/reference/swf/functions/swf-translate.xml @@ -1,13 +1,13 @@ - - + swf_translate Translate the current transformations - - Description + + + &reftitle.description; voidswf_translate floatx @@ -15,10 +15,46 @@ floatz - The swf_translate function translates the - current transformation by the x, - y, and z values - given. + Translates the current transformation by the given values. + + + + + &reftitle.parameters; + + + + x + + + x value. + + + + + y + + + y value. + + + + + z + + + z value. + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/swf/functions/swf-viewport.xml b/reference/swf/functions/swf-viewport.xml index 5760ccf48b..08c7c8438b 100644 --- a/reference/swf/functions/swf-viewport.xml +++ b/reference/swf/functions/swf-viewport.xml @@ -1,13 +1,13 @@ - - + swf_viewport Select an area for future drawing - - Description + + + &reftitle.description; voidswf_viewport floatxmin @@ -16,13 +16,55 @@ floatymax - The swf_viewport function selects an area - for future drawing for xmin to + 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. + + + &reftitle.parameters; + + + + xmin + + + + + + + xmax + + + + + + + ymin + + + + + + + ymax + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + +