stencyl.api.engine.behavior.ActorScript

	Property	Defined By
		actor : Actor	ActorScript
		BACK : int = 2 [static]	Script
		FRONT : int = 0 [static]	Script
		GET_SCORES_URL : String = http://www.stencyl.com/v10/api/score/getTopEntries/ [static]	Script
		GET_SCORE_URL : String = http://www.stencyl.com/v10/api/score/getForCurrentPlayer/ [static]	Script
		lastCreatedActor : Actor = null [static]	Script
		lastCreatedJoint : b2Joint = null [static]	Script
		lastCreatedLabel : Label = null [static]	Script
		lastCreatedPanel : Panel = null [static]	Script
		lastCreatedRegion : Region = null [static]	Script
		lastCreatedTerrainRegion : TerrainRegion = null [static]	Script
		MIDDLE : int = 1 [static]	Script
		mpx : Number = 0 [static]	Script
		mpy : Number = 0 [static]	Script
		mrx : Number = 0 [static]	Script
		mry : Number = 0 [static]	Script
		scene : GameState	Script
		SUBMIT_SCORE_URL : String = http://www.stencyl.com/v10/api/score/submit/ [static]	Script
		wrapper : Behavior	Script

Public Methods

	Method		Defined By
		ActorScript(actor:Actor, scene:GameState)	ActorScript
		abortTween(target:Object):void [static]	Script
		AddUnsigned(lX:, lY:):*	Script
		adjustLocationForAllSounds(time:uint, volume:Number):void	Script
		asBoolean(o:*):Boolean [static] Accepts a literal boolean or String boolean.	Script
		bringRootPanelForward():void	Script
		bringRootPanelToFront():void	Script
		ConvertToWordArray(string:String):*	Script
		createActor(type:ActorType, x:Number, y:Number, layerConst:int):Actor Creates an actor of the given type at the given location and layer.	Script
		createActorInNextScene(type:ActorType, x:Number, y:Number, layerConst:int):void Creates an actor of the given type at the given location and layer when the next scene begins.	Script
		createBoxRegion(x:int, y:int, w:int, h:int):Region Create a rectangular Region	Script
		createBoxTerrainRegion(x:int, y:int, w:int, h:int):TerrainRegion Create a rectangular TerrainRegion	Script
		createBrightnessFilter(b:Number):ColorMatrixFilter [static]	Script
		createCircularRegion(x:int, y:int, r:int):Region Create a circular Region	Script
		createCircularTerrainRegion(x:int, y:int, r:int):TerrainRegion Create a circular TerrainRegion	Script
		createFadeIn(duration:uint, color:uint = 0xff000000):Transition Create a fade in transition for use in scene switching.	Script
		createFadeOut(duration:uint, color:uint = 0xff000000):Transition Create a fade out transition for use in scene switching.	Script
		createGrayscaleFilter():ColorMatrixFilter [static]	Script
		createHingeJoint(one:b2Body, two:b2Body = null, pt:V2 = null):b2RevoluteJoint	Script
		createHueFilter(h:Number):ColorMatrixFilter [static]	Script
		createLabel(font:Font, text:String, x:int, y:int):Label	Script
		createMultilineLabel(font:Font, text:String, x:int, y:int, w:int):Panel	Script
		createNegativeFilter():ColorMatrixFilter [static]	Script
		createPanel(x:int, y:int, w:int, h:int):Panel	Script
		createRecycledActor(type:ActorType, x:Number, y:Number, layerConst:int):Actor Creates an actor of the given type at the given location and layer.	Script
		createSaturationFilter(s:Number):ColorMatrixFilter [static]	Script
		createSepiaFilter():ColorMatrixFilter [static]	Script
		createSlidingJoint(one:b2Body, two:b2Body = null, dir:V2 = null):b2LineJoint	Script
		createStickJoint(one:b2Body, two:b2Body, p1:V2 = null, p2:V2 = null):b2DistanceJoint	Script
		createTintFilter(color:uint, amount:Number = 1):ColorMatrixFilter [static]	Script
		destroyJoint(j:b2Joint):void	Script
		destroyJointByID(jointID:int):void	Script
		disableBehaviorForScene(behaviorName:String):void Disable the given Behavior (by name) for the current scene	Script
		disableCursor():void	Script
		disableDebugDrawing():void	Script
		disableGlobalSleeping():void	Script
		disableThisBehavior():void [override]	ActorScript
		doesCustomDrawing():void Call this if you need to do any drawing using draw()	Script
		draw(g:Graphics, x:Number, y:Number):void	Script
		enableBehaviorForScene(behaviorName:String):void Enable the given Behavior (by name) for the current scene	Script
		enableContinuousCollisions():void	Script
		enableCursor():void	Script
		enableDebugDrawing(debugColor:uint = 0xff000000):void	Script
		enableGlobalSleeping():void	Script
		enteredRegion(r:Region, a:Actor):void	Script
		F(x:, y:, z:):	Script
		fadeInForAllSounds(time:int):void	Script
		fadeOutForAllSounds(time:int):void	Script
		fadeTileLayerTo(layerID:uint, alphaPct:uint, duration:uint, easing:String = linear):void Force the given layer to fade to the given opacity over time, applying the easing function.	Script
		FF(a:, b:, c:, d:, x:, s:, ac:):	Script
		format(message:String, ... args):void	Script
		forwardMessage(msg:String):void Internal use only.	Script
		G(x:, y:, z:):	Script
		getActor(actorID:Number):Actor	Script
		getActorGroup(groupID:Number):FlxGroup	Script
		getActorsAlongLine(x1:int, y1:int, x2:int, y2:int, callback:Function):void	Script
		getActorsAtPoint(x:int, y:int, callback:Function):void	Script
		getActorsInArea(x:int, y:int, w:int, h:int, callback:Function):void	Script
		getActorsInRegion(r:Region):Array Returns an Array of Actors that intersect the Region	Script
		getActorsOfType(type:ActorType):HashSet	Script
		getActorsOnScreen(callback:Function):void	Script
		getActorType(actorTypeID:uint):ActorType	Script
		getActorTypeByName(typeName:String):ActorType	Script
		getAllActorTypes():Array	Script
		getAllRegions():Array Get all Regions in a Scene	Script
		getAllTerrainRegions():Array Get all Regions in a Scene	Script
		getBottomLayer():int	Script
		getCamera():Actor Returns the actor that represents the camera	Script
		getCurrentScene():uint Get the ID of the current scene.	Script
		getCurrentSceneName():String Get the name of the current scene.	Script
		getFont(fontID:uint):Font	Script
		getFPS():uint	Script
		getGameAttribute(name:String):*	Script
		getGravity():V2	Script
		getGroundBody():b2Body	Script
		getIDForResource(name:String):uint	Script
		getIDForScene(sceneName:String):uint Get the ID of a scene by name.	Script
		getImageForActorType(type:ActorType):BitmapData Returns the 'default' image for the given actor type.	Script
		getJoint(jointID:int):b2Joint	Script
		getLastCreatedActor():Actor Returns the last actor created in this scene.	Script
		getLastCreatedJoint():b2Joint	Script
		getLastCreatedLabel():Label	Script
		getLastCreatedPanel():Panel	Script
		getLastCreatedRegion():Region Return the last created region	Script
		getLastCreatedTerrainRegion():TerrainRegion Return the last created terrain region	Script
		getMiddleLayer():int	Script
		getMousePressedX():Number	Script
		getMousePressedY():Number	Script
		getMouseReleasedX():Number	Script
		getMouseReleasedY():Number	Script
		getMouseWorldX():Number	Script
		getMouseWorldY():Number	Script
		getMouseX():Number	Script
		getMouseY():Number	Script
		getPlayerName():String	Script
		getRegion(regionID:int):Region Get a particular Region based on internal ID	Script
		getRootPanel():Panel	Script
		getScene():Scene Get the current scene.	Script
		getSceneHeight():uint Get the height (in pixels) of the current scene.	Script
		getSceneWidth():uint Get the width (in pixels) of the current scene.	Script
		getScore(scoreName:String, callback:Function = null):void	Script
		getScores(scoreName:String, numberToGrab:uint, callback:Function = null):void	Script
		getScreenHeight():uint	Script
		getScreenWidth():uint	Script
		getScreenX():int x-position of the camera	Script
		getScreenY():int y-position of the camera	Script
		getSound(soundID:uint):SoundClip	Script
		getStepSize():uint	Script
		getTerrainRegion(terrainRegionID:int):TerrainRegion Get a particular Region based on internal ID	Script
		getTileAt(row:int, col:int, layer:int):Tile Returns the Tile at the specified row and column, or null if no tile is found nbsp;	Script
		getTileHeight():uint Get the height (in tiles) of the current scene.	Script
		getTileWidth():uint Get the width (in tiles) of the current scene.	Script
		getTopLayer():int	Script
		getValue(behaviorName:String, attributeName:String):Object	ActorScript
		getValueForScene(behaviorName:String, attributeName:String):Object	Script
		GG(a:, b:, c:, d:, x:, s:, ac:):	Script
		H(x:, y:, z:):	Script
		handleCollision(event:Collision):void Handle a collision with another Actor.	Script
		handlesCollisions():void	ActorScript
		HH(a:, b:, c:, d:, x:, s:, ac:):	Script
		hideCursor():void	Script
		hideFPS():void	Script
		hideTileLayer(layerID:uint):void Force the given layer to become invisible.	Script
		I(x:, y:, z:):	Script
		II(a:, b:, c:, d:, x:, s:, ac:):	Script
		init():void Called whenever this Actor or Scene is created.	Script
		initKongregate():void	Script
		isBehaviorEnabledForScene(behaviorName:String):Boolean Check if the current scene contains the given Behavior (by name) and if said behavior is enabled.	Script
		isCtrlDown():Boolean	Script
		isGuest():Boolean	Script
		isInRegion(a:Actor, r:Region):Boolean Check whether the Actor intersects the Region	Script
		isKeyDown(abstractKey:String):Boolean	Script
		isKeyPressed(abstractKey:String):Boolean	Script
		isKeyReleased(abstractKey:String):Boolean	Script
		isMouseDown():Boolean	Script
		isMousePressed():Boolean	Script
		isMouseReleased():Boolean	Script
		isShiftDown():Boolean	Script
		isTransitioning():Boolean	Script
		kongGetUserId():Number	Script
		kongGetUsername():String	Script
		kongIsGuest():Boolean	Script
		kongSubmitStat(statName:String, value:Number):void	Script
		leftRegion(r:Region, a:Actor):void	Script
		loadGame(fileName:String, callback:Function = null):void	Script
		makeActorNotPassThroughTerrain(actor:Actor):void	Script
		MD5(string:String):String	Script
		mute():void	Script
		openURLInBrowser(URL:String):void	Script
		pauseAll():void	Script
		preWrap(text:String, maxWidth:int, font:Font):String	Script
		print(message:*):void	Script
		randomFloat():Number	Script
		randomInt(low:int, high:int):Number	Script
		recycleActor(a:Actor):void	Script
		reloadCurrentScene(leave:Transition = null, enter:Transition = null):void Reload the current scene, using an exit transition and then an enter transition.	Script
		removeRegion(regionID:int):void Remove a Region from a Scene	Script
		removeTerrainRegion(terrainRegionID:int):void Remove a Region from a Scene	Script
		removeTileAt(row:int, col:int, layer:int):void Remove a tile from a scene at runtime at the specified row and column.	Script
		retrieveSaves(callback:Function = null):void	Script
		RotateLeft(lValue:, iShiftBits:):* MD5 (Message-Digest Algorithm) http://www.webtoolkit.info/	Script
		runLater(delay:uint, toExecute:Function):void Runs the given function after a delay.	Script
		runPeriodically(interval:uint, toExecute:Function):void Runs the given function periodically (every n seconds).	Script
		sameAs(one:, two:):Boolean [static] A generic way to compare two values or objects.	Script
		saveGame(fileName:String, displayTitle:String, callback:Function = null):void	Script
		sayToScene(behaviorName:String, msg:String, ... args):Object	Script
		sceneHasBehavior(behaviorName:String):Boolean Check if the current scene contains the given Behavior (by name)	Script
		sendRootPanelBack():void	Script
		sendRootPanelToBack():void	Script
		setCursor(graphic:Class = null, xOffset:int = 0, yOffset:int = 0):void	Script
		setFPS(desiredFPS:uint):void	Script
		setGameAttribute(name:String, value:*):void	Script
		setGravity(x:Number, y:Number):void	Script
		setLocationForAllSounds(location:Number):void	Script
		setOffscreenTolerance(top:int, left:int, bottom:int, right:int):void	Script
		setScrollSpeedForBackground(xSpeed:Number, ySpeed:Number):void	Script
		setTileAt(row:int, col:int, layer:int, tilesetID:int, tileID:int):void Add a tile to the scene at runtime in the specified row and column	Script
		setTimeScale(scale:Number):void	Script
		setValue(behaviorName:String, attributeName:String, value:Object):void	ActorScript
		setValueForScene(behaviorName:String, attributeName:String, value:Object):void	Script
		setVolumeForAllSounds(volume:Number):void	Script
		shout(msg:String, ... args):Object	ActorScript
		shoutToScene(msg:String, ... args):Object	Script
		showCursor():void	Script
		showTileLayer(layerID:uint):void Force the given layer to show.	Script
		simpleTweet(message:String, gameURL:String):void	Script
		startFadeIn(color:uint = 0xffffffff, duration:Number = 1000, forceReset:Boolean = false):void	Script
		startFadeOut(color:uint = 0xffffffff, duration:Number = 1000, forceReset:Boolean = false):void	Script
		startShakingScreen(intensity:Number = 0.05, duration:Number = 500):void	Script
		stopAllSounds():void	Script
		stopFadeIn():void	Script
		stopFadeOut():void	Script
		stopShakingScreen():void	Script
		submitScore(scoreName:String, value:Number, callback:Function = null):void	Script
		switchScene(sceneID:uint, leave:Transition = null, enter:Transition = null):void Switch to the given scene, using an exit transition and then an enter transition.	Script
		toPhysicalUnits(value:Number):Number	Script
		toPixelUnits(value:Number):Number	Script
		tween(attribute:Object = null, params:Object = null):Boolean [static]	Script
		tweenNumber(attributeName:String, toValue:Number, duration:Number, easing:String):Boolean	Script
		unmute():void	Script
		unpauseAll():void	Script
		update():void Called each time the game steps forward.	Script
		Utf8Encode(string:String):String	Script
		visitURL(URL:String, callback:Function = null):void	Script
		WordToHex(lValue:):	Script
		wordWrap(text:String, maxWidth:int, font:Font):Array	Script

	Method	Defined By
		registerCollisionHandler(a:Actor):void Call this if you want to receive collision events for the actor.	Script

Property Detail

actor

property

public var actor:Actor

Constructor Detail

ActorScript

()

Constructor

public function ActorScript(actor:Actor, scene:GameState)

Parameters

	`actor:Actor`

	`scene:GameState`

Method Detail

disableThisBehavior

()

method

override public function disableThisBehavior():void

getValue

()

method

public function getValue(behaviorName:String, attributeName:String):Object

Parameters

	`behaviorName:String`

	`attributeName:String`

Returns

Object

handlesCollisions

()

method

public function handlesCollisions():void

setValue

()

method

public function setValue(behaviorName:String, attributeName:String, value:Object):void

Parameters

	`behaviorName:String`

	`attributeName:String`

	`value:Object`

shout

()

method

public function shout(msg:String, ... args):Object

Parameters

	`msg:String`

	`... args`

Returns

Object

Sun Apr 17 2011, 12:17 AM -07:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
ActorScript	Properties \| Methods

Package	stencyl.api.engine.behavior
Class	public dynamic class ActorScript
Inheritance	ActorScript Script Object