| Package | net.flashpunk |
| Class | public class FP |
| Inheritance | FP  Object |
| Property | Defined By | ||
|---|---|---|---|
| assignedFrameRate : Number [static]
The framerate assigned to the stage. | FP | ||
| bounds : Rectangle [static]
A rectangle representing the size of the screen. | FP | ||
| buffer : BitmapData [static]
The current screen buffer, drawn to in the render loop. | FP | ||
| camera : Point [static]
Point used to determine drawing offset in the render loop. | FP | ||
| console : Console [static] [read-only]
The global Console object. | FP | ||
| elapsed : Number [static]
Time elapsed since the last frame (in seconds). | FP | ||
| fixed : Boolean [static]
If the game is running at a fixed framerate. | FP | ||
| focused : Boolean = true [static]
If the game currently has input focus or not. | FP | ||
| frameRate : Number [static]
The framerate assigned to the stage. | FP | ||
| halfHeight : Number [static]
Half height of the game. | FP | ||
| halfWidth : Number [static]
Half width of the game. | FP | ||
| height : uint [static]
Height of the game. | FP | ||
| pan : Number [static]
Global panning factor for all sounds, a value from -1 to 1. | FP | ||
| random : Number [static] [read-only]
A pseudo-random Number produced using FP's random seed, where 0 <= Number < 1. | FP | ||
| randomSeed : uint [static]
The random seed used by FP's random functions. | FP | ||
| rate : Number = 1 [static]
Timescale applied to FP.elapsed. | FP | ||
| screen : Screen [static]
The Screen object, use to transform or offset the Screen. | FP | ||
| timeInFrames : Boolean [static]
If times should be given in frames (as opposed to seconds). | FP | ||
| tweener : Tweener [static]
Global Tweener for tweening values across multiple worlds. | FP | ||
| volume : Number [static]
Global volume factor for all sounds, a value from 0 to 1. | FP | ||
| width : uint [static]
Width of the game. | FP | ||
| world : World [static]
The currently active World object. | FP | ||
| Method | Defined By | ||
|---|---|---|---|
[static]
Schedules a callback for the future. | FP | ||
anchorTo(object:Object, anchor:Object, distance:Number = 0):void [static]
Anchors the object to a position. | FP | ||
angle(x1:Number, y1:Number, x2:Number, y2:Number):Number [static]
Finds the angle (in degrees) from point 1 to point 2. | FP | ||
angleDiff(a:Number, b:Number):Number [static]
Gets the difference of two angles, wrapped around to the range -180 to 180. | FP | ||
angleXY(object:Object, angle:Number, length:Number = 1, x:Number = 0, y:Number = 0):void [static]
Sets the x/y values of the provided object to a vector of the specified angle and length. | FP | ||
approach(value:Number, target:Number, amount:Number):Number [static]
Approaches the value towards the target, by the specified amount, without overshooting the target. | FP | ||
choose(... objs):* [static]
Randomly chooses and returns one of the provided values. | FP | ||
clamp(value:Number, min:Number, max:Number):Number [static]
Clamps the value within the minimum and maximum values. | FP | ||
clampInRect(object:Object, x:Number, y:Number, width:Number, height:Number, padding:Number = 0):void [static]
Clamps the object inside the rectangle. | FP | ||
clearBitmapCache():void [static]
Clears the cache of BitmapData objects used by the getBitmap method. | FP | ||
colorLerp(fromColor:uint, toColor:uint, t:Number = 1):uint [static]
Linear interpolation between two colors. | FP | ||
distance(x1:Number, y1:Number, x2:Number = 0, y2:Number = 0):Number [static]
Find the distance between two points. | FP | ||
distanceRectPoint(px:Number, py:Number, rx:Number, ry:Number, rw:Number, rh:Number):Number [static]
Find the distance between a point and a rectangle. | FP | ||
distanceRects(x1:Number, y1:Number, w1:Number, h1:Number, x2:Number, y2:Number, w2:Number, h2:Number):Number [static]
Find the distance between two rectangles. | FP | ||
frames(from:int, to:int, skip:int = 0):Array [static]
Gets an array of frame indices. | FP | ||
getBitmap(source:Class):BitmapData [static]
Fetches a stored BitmapData object represented by the source. | FP | ||
getBlue(color:uint):uint [static]
Finds the blue factor of a color. | FP | ||
getColorHSV(h:Number, s:Number, v:Number):uint [static]
Creates a color value with the chosen HSV values. | FP | ||
getColorHue(color:uint):Number [static] | FP | ||
getColorRGB(R:uint = 0, G:uint = 0, B:uint = 0):uint [static]
Creates a color value by combining the chosen RGB values. | FP | ||
getColorSaturation(color:uint):Number [static] | FP | ||
getColorValue(color:uint):Number [static] | FP | ||
getGreen(color:uint):uint [static]
Finds the green factor of a color. | FP | ||
getRed(color:uint):uint [static]
Finds the red factor of a color. | FP | ||
getXML(file:Class):XML [static]
Loads the file as an XML object. | FP | ||
lerp(a:Number, b:Number, t:Number = 1):Number [static]
Linear interpolation between two values. | FP | ||
log(... data):void [static]
Logs data to the console. | FP | ||
next(current:*, options:Array, loop:Boolean = true):* [static]
Returns the next item after current in the list of options. | FP | ||
prev(current:*, options:Array, loop:Boolean = true):* [static]
Returns the item previous to the current in the list of options. | FP | ||
rand(amount:uint):uint [static]
Returns a pseudo-random uint. | FP | ||
randomizeSeed():void [static]
Randomizes the random seed using Flash's Math.random() function. | FP | ||
remove(array:*, toRemove:*):Boolean [static]
Remove an element from an array
| FP | ||
resetCamera():void [static]
Resets the camera position. | FP | ||
resize(width:int, height:int):void [static]
Resize the screen. | FP | ||
rotateAround(object:Object, anchor:Object, angle:Number = 0, relative:Boolean = true):void [static]
Rotates the object around the anchor by the specified amount. | FP | ||
scale(value:Number, min:Number, max:Number, min2:Number, max2:Number):Number [static]
Transfers a value from one scale to another scale. | FP | ||
scaleClamp(value:Number, min:Number, max:Number, min2:Number, max2:Number):Number [static]
Transfers a value from one scale to another scale, but clamps the return value within the second scale. | FP | ||
setCamera(x:Number = 0, y:Number = 0):void [static]
Sets the camera position. | FP | ||
shuffle(a:Object):void [static]
Shuffles the elements in the array. | FP | ||
sign(value:Number):int [static]
Finds the sign of the provided value. | FP | ||
sort(object:Object, ascending:Boolean = true):void [static]
Sorts the elements in the array. | FP | ||
sortBy(object:Object, property:String, ascending:Boolean = true):void [static]
Sorts the elements in the array by a property of the element. | FP | ||
stepTowards(object:Object, x:Number, y:Number, distance:Number = 1):void [static]
Steps the object towards a point. | FP | ||
swap(current:*, a:*, b:*):* [static]
Swaps the current item between a and b. | FP | ||
timeFlag():uint [static]
Sets a time flag. | FP | ||
tween(object:Object, values:Object, duration:Number, options:Object = null):MultiVarTween [static]
Tweens numeric public properties of an Object. | FP | ||
watch(... properties):void [static]
Adds properties to watch in the console's debug panel. | FP | ||
| Constant | Defined By | ||
|---|---|---|---|
| VERSION : String = 1.7.2 [static]
The FlashPunk major version. | FP | ||
| assignedFrameRate | property |
public static var assignedFrameRate:NumberThe framerate assigned to the stage.
| bounds | property |
public static var bounds:RectangleA rectangle representing the size of the screen.
| buffer | property |
public static var buffer:BitmapDataThe current screen buffer, drawn to in the render loop.
| camera | property |
public static var camera:PointPoint used to determine drawing offset in the render loop.
| console | property |
console:Console [read-only] The global Console object.
public static function get console():Console| elapsed | property |
public static var elapsed:NumberTime elapsed since the last frame (in seconds).
| fixed | property |
public static var fixed:BooleanIf the game is running at a fixed framerate.
| focused | property |
public static var focused:Boolean = trueIf the game currently has input focus or not. Note: may not be correct initially.
| frameRate | property |
public static var frameRate:NumberThe framerate assigned to the stage.
| halfHeight | property |
public static var halfHeight:NumberHalf height of the game.
| halfWidth | property |
public static var halfWidth:NumberHalf width of the game.
| height | property |
public static var height:uintHeight of the game.
| pan | property |
pan:NumberGlobal panning factor for all sounds, a value from -1 to 1.
public static function get pan():Number public static function set pan(value:Number):void| random | property |
random:Number [read-only] A pseudo-random Number produced using FP's random seed, where 0 <= Number < 1.
public static function get random():Number| randomSeed | property |
randomSeed:uintThe random seed used by FP's random functions.
public static function get randomSeed():uint public static function set randomSeed(value:uint):void| rate | property |
public static var rate:Number = 1Timescale applied to FP.elapsed.
| screen | property |
public static var screen:ScreenThe Screen object, use to transform or offset the Screen.
| timeInFrames | property |
public static var timeInFrames:BooleanIf times should be given in frames (as opposed to seconds). Default is true in fixed timestep mode and false in variable timestep mode.
| tweener | property |
public static var tweener:TweenerGlobal Tweener for tweening values across multiple worlds.
| volume | property |
volume:NumberGlobal volume factor for all sounds, a value from 0 to 1.
public static function get volume():Number public static function set volume(value:Number):void| width | property |
public static var width:uintWidth of the game.
| world | property |
world:WorldThe currently active World object. When you set this, the World is flagged to switch, but won't actually do so until the end of the current frame.
public static function get world():World public static function set world(value:World):void| alarm | () | method |
public static function alarm(delay:Number, callback:Function, type:uint = 2, tweener:Tweener = null):AlarmSchedules a callback for the future. Shorthand for creating an Alarm tween, starting it and adding it to a Tweener.
Parameters
delay:Number — The duration to wait before calling the callback.
| |
callback:Function — The function to be called.
| |
type:uint (default = 2) | |
tweener:Tweener (default = null) |
Alarm — The added Alarm object.
Example: FP.alarm(5.0, callbackFunction, Tween.LOOPING); // Calls callbackFunction every 5 seconds
|
| anchorTo | () | method |
public static function anchorTo(object:Object, anchor:Object, distance:Number = 0):voidAnchors the object to a position.
Parameters
object:Object — The object to anchor.
| |
anchor:Object — The anchor object.
| |
distance:Number (default = 0) |
| angle | () | method |
public static function angle(x1:Number, y1:Number, x2:Number, y2:Number):NumberFinds the angle (in degrees) from point 1 to point 2.
Parameters
x1:Number — The first x-position.
| |
y1:Number — The first y-position.
| |
x2:Number — The second x-position.
| |
y2:Number — The second y-position.
|
Number — The angle from (x1, y1) to (x2, y2).
|
| angleDiff | () | method |
public static function angleDiff(a:Number, b:Number):NumberGets the difference of two angles, wrapped around to the range -180 to 180.
Parameters
a:Number — First angle in degrees.
| |
b:Number — Second angle in degrees.
|
Number — Difference in angles, wrapped around to the range -180 to 180.
|
| angleXY | () | method |
public static function angleXY(object:Object, angle:Number, length:Number = 1, x:Number = 0, y:Number = 0):voidSets the x/y values of the provided object to a vector of the specified angle and length.
Parameters
object:Object — The object whose x/y properties should be set.
| |
angle:Number — The angle of the vector, in degrees.
| |
length:Number (default = 1) | |
x:Number (default = 0) | |
y:Number (default = 0) |
| approach | () | method |
public static function approach(value:Number, target:Number, amount:Number):NumberApproaches the value towards the target, by the specified amount, without overshooting the target.
Parameters
value:Number — The starting value.
| |
target:Number — The target that you want value to approach.
| |
amount:Number — How much you want the value to approach target by.
|
Number — The new value.
|
| choose | () | method |
public static function choose(... objs):*Randomly chooses and returns one of the provided values.
Parameters
... objs — The Objects you want to randomly choose from. Can be ints, Numbers, Points, etc.
|
* — A randomly chosen one of the provided parameters.
|
| clamp | () | method |
public static function clamp(value:Number, min:Number, max:Number):NumberClamps the value within the minimum and maximum values.
Parameters
value:Number — The Number to evaluate.
| |
min:Number — The minimum range.
| |
max:Number — The maximum range.
|
Number — The clamped value.
|
| clampInRect | () | method |
public static function clampInRect(object:Object, x:Number, y:Number, width:Number, height:Number, padding:Number = 0):voidClamps the object inside the rectangle.
Parameters
object:Object — The object to clamp (must have an x and y property).
| |
x:Number — Rectangle's x.
| |
y:Number — Rectangle's y.
| |
width:Number — Rectangle's width.
| |
height:Number — Rectangle's height.
| |
padding:Number (default = 0) |
| clearBitmapCache | () | method |
public static function clearBitmapCache():voidClears the cache of BitmapData objects used by the getBitmap method.
| colorLerp | () | method |
public static function colorLerp(fromColor:uint, toColor:uint, t:Number = 1):uintLinear interpolation between two colors.
Parameters
fromColor:uint — First color.
| |
toColor:uint — Second color.
| |
t:Number (default = 1) |
uint |
| distance | () | method |
public static function distance(x1:Number, y1:Number, x2:Number = 0, y2:Number = 0):NumberFind the distance between two points.
Parameters
x1:Number — The first x-position.
| |
y1:Number — The first y-position.
| |
x2:Number (default = 0) | |
y2:Number (default = 0) |
Number — The distance.
|
| distanceRectPoint | () | method |
public static function distanceRectPoint(px:Number, py:Number, rx:Number, ry:Number, rw:Number, rh:Number):NumberFind the distance between a point and a rectangle. Returns 0 if the point is within the rectangle.
Parameters
px:Number — The x-position of the point.
| |
py:Number — The y-position of the point.
| |
rx:Number — The x-position of the rect.
| |
ry:Number — The y-position of the rect.
| |
rw:Number — The width of the rect.
| |
rh:Number — The height of the rect.
|
Number — The distance.
|
| distanceRects | () | method |
public static function distanceRects(x1:Number, y1:Number, w1:Number, h1:Number, x2:Number, y2:Number, w2:Number, h2:Number):NumberFind the distance between two rectangles. Will return 0 if the rectangles overlap.
Parameters
x1:Number — The x-position of the first rect.
| |
y1:Number — The y-position of the first rect.
| |
w1:Number — The width of the first rect.
| |
h1:Number — The height of the first rect.
| |
x2:Number — The x-position of the second rect.
| |
y2:Number — The y-position of the second rect.
| |
w2:Number — The width of the second rect.
| |
h2:Number — The height of the second rect.
|
Number — The distance.
|
| frames | () | method |
public static function frames(from:int, to:int, skip:int = 0):ArrayGets an array of frame indices.
Parameters
from:int — Starting frame.
| |
to:int — Ending frame.
| |
skip:int (default = 0) |
Array |
| getBitmap | () | method |
public static function getBitmap(source:Class):BitmapDataFetches a stored BitmapData object represented by the source.
Parameters
source:Class — Embedded Bitmap class.
|
BitmapData — The stored BitmapData object.
|
| getBlue | () | method |
public static function getBlue(color:uint):uintFinds the blue factor of a color.
Parameters
color:uint — The color to evaluate.
|
uint — A uint from 0 to 255.
|
| getColorHSV | () | method |
public static function getColorHSV(h:Number, s:Number, v:Number):uintCreates a color value with the chosen HSV values.
Parameters
h:Number — The hue of the color (from 0 to 1).
| |
s:Number — The saturation of the color (from 0 to 1).
| |
v:Number — The value of the color (from 0 to 1).
|
uint — The color uint.
|
| getColorHue | () | method |
public static function getColorHue(color:uint):NumberParameters
color:uint |
Number |
| getColorRGB | () | method |
public static function getColorRGB(R:uint = 0, G:uint = 0, B:uint = 0):uintCreates a color value by combining the chosen RGB values.
Parameters
R:uint (default = 0) | |
G:uint (default = 0) | |
B:uint (default = 0) |
uint — The color uint.
|
| getColorSaturation | () | method |
public static function getColorSaturation(color:uint):NumberParameters
color:uint |
Number |
| getColorValue | () | method |
public static function getColorValue(color:uint):NumberParameters
color:uint |
Number |
| getGreen | () | method |
public static function getGreen(color:uint):uintFinds the green factor of a color.
Parameters
color:uint — The color to evaluate.
|
uint — A uint from 0 to 255.
|
| getRed | () | method |
public static function getRed(color:uint):uintFinds the red factor of a color.
Parameters
color:uint — The color to evaluate.
|
uint — A uint from 0 to 255.
|
| getXML | () | method |
public static function getXML(file:Class):XMLLoads the file as an XML object.
Parameters
file:Class — The embedded file to load.
|
XML — An XML object representing the file.
|
| lerp | () | method |
public static function lerp(a:Number, b:Number, t:Number = 1):NumberLinear interpolation between two values.
Parameters
a:Number — First value.
| |
b:Number — Second value.
| |
t:Number (default = 1) |
Number — When t=0, returns a. When t=1, returns b. When t=0.5, will return halfway between a and b. Etc.
|
| log | () | method |
public static function log(... data):voidLogs data to the console.
Parameters
... data — The data parameters to log, can be variables, objects, etc. Parameters will be separated by a space (" ").
|
| next | () | method |
public static function next(current:*, options:Array, loop:Boolean = true):*Returns the next item after current in the list of options.
Parameters
current:* — The currently selected item (must be one of the options).
| |
options:Array — An array of all the items to cycle through.
| |
loop:Boolean (default = true) |
* — The next item in the list.
|
| prev | () | method |
public static function prev(current:*, options:Array, loop:Boolean = true):*Returns the item previous to the current in the list of options.
Parameters
current:* — The currently selected item (must be one of the options).
| |
options:Array — An array of all the items to cycle through.
| |
loop:Boolean (default = true) |
* — The previous item in the list.
|
| rand | () | method |
public static function rand(amount:uint):uintReturns a pseudo-random uint.
Parameters
amount:uint — The returned uint will always be 0 <= uint < amount.
|
uint — The uint.
|
| randomizeSeed | () | method |
public static function randomizeSeed():voidRandomizes the random seed using Flash's Math.random() function.
| remove | () | method |
public static function remove(array:*, toRemove:*):BooleanRemove an element from an array
Parameters
array:* | |
toRemove:* |
Boolean — True if element existed and has been removed, false if element was not in array.
|
| resetCamera | () | method |
public static function resetCamera():voidResets the camera position.
| resize | () | method |
public static function resize(width:int, height:int):voidResize the screen.
Parameters
width:int — New width.
| |
height:int — New height.
|
| rotateAround | () | method |
public static function rotateAround(object:Object, anchor:Object, angle:Number = 0, relative:Boolean = true):voidRotates the object around the anchor by the specified amount.
Parameters
object:Object — Object to rotate around the anchor.
| |
anchor:Object — Anchor to rotate around.
| |
angle:Number (default = 0) | |
relative:Boolean (default = true) |
| scale | () | method |
public static function scale(value:Number, min:Number, max:Number, min2:Number, max2:Number):NumberTransfers a value from one scale to another scale. For example, scale(.5, 0, 1, 10, 20) == 15, and scale(3, 0, 5, 100, 0) == 40.
Parameters
value:Number — The value on the first scale.
| |
min:Number — The minimum range of the first scale.
| |
max:Number — The maximum range of the first scale.
| |
min2:Number — The minimum range of the second scale.
| |
max2:Number — The maximum range of the second scale.
|
Number — The scaled value.
|
| scaleClamp | () | method |
public static function scaleClamp(value:Number, min:Number, max:Number, min2:Number, max2:Number):NumberTransfers a value from one scale to another scale, but clamps the return value within the second scale.
Parameters
value:Number — The value on the first scale.
| |
min:Number — The minimum range of the first scale.
| |
max:Number — The maximum range of the first scale.
| |
min2:Number — The minimum range of the second scale.
| |
max2:Number — The maximum range of the second scale.
|
Number — The scaled and clamped value.
|
| setCamera | () | method |
public static function setCamera(x:Number = 0, y:Number = 0):voidSets the camera position.
Parameters
x:Number (default = 0) | |
y:Number (default = 0) |
| shuffle | () | method |
public static function shuffle(a:Object):voidShuffles the elements in the array.
Parameters
a:Object — The Object to shuffle (an Array or Vector).
|
| sign | () | method |
public static function sign(value:Number):intFinds the sign of the provided value.
Parameters
value:Number — The Number to evaluate.
|
int — 1 if value > 0, -1 if value < 0, and 0 when value == 0.
|
| sort | () | method |
public static function sort(object:Object, ascending:Boolean = true):voidSorts the elements in the array.
Parameters
object:Object — The Object to sort (an Array or Vector).
| |
ascending:Boolean (default = true) |
| sortBy | () | method |
public static function sortBy(object:Object, property:String, ascending:Boolean = true):voidSorts the elements in the array by a property of the element.
Parameters
object:Object — The Object to sort (an Array or Vector).
| |
property:String — The numeric property of object's elements to sort by.
| |
ascending:Boolean (default = true) |
| stepTowards | () | method |
public static function stepTowards(object:Object, x:Number, y:Number, distance:Number = 1):voidSteps the object towards a point.
Parameters
object:Object — Object to move (must have an x and y property).
| |
x:Number — X position to step towards.
| |
y:Number — Y position to step towards.
| |
distance:Number (default = 1) |
| swap | () | method |
public static function swap(current:*, a:*, b:*):*Swaps the current item between a and b. Useful for quick state/string/value swapping.
Parameters
current:* — The currently selected item.
| |
a:* — Item a.
| |
b:* — Item b.
|
* — Returns a if current is b, and b if current is a.
|
| timeFlag | () | method |
public static function timeFlag():uintSets a time flag.
Returnsuint — Time elapsed (in milliseconds) since the last time flag was set.
|
| tween | () | method |
public static function tween(object:Object, values:Object, duration:Number, options:Object = null):MultiVarTweenTweens numeric public properties of an Object. Shorthand for creating a MultiVarTween tween, starting it and adding it to a Tweener.
Parameters
object:Object — The object containing the properties to tween.
| |
values:Object — An object containing key/value pairs of properties and target values.
| |
duration:Number — Duration of the tween.
| |
options:Object (default = null) |
MultiVarTween — The added MultiVarTween object.
Example: FP.tween(object, { x: 500, y: 350 }, 2.0, { ease: easeFunction, complete: onComplete } );
|
| watch | () | method |
public static function watch(... properties):voidAdds properties to watch in the console's debug panel.
Parameters
... properties — The properties (strings) to watch.
|
| VERSION | Constant |
public static const VERSION:String = 1.7.2The FlashPunk major version.