FlxSpriteUtil

API Reference > flixel.util > FlxSpriteUtil

FlxSpriteUtil

FlxSprite / FlxObjectを操作するユーティリティクラスです



staticメソッド

screenWrap() : 指定のFlxSpriteを画面端でラップし、反対方向に移動させます

  • 引数
    • sprite:FlxSprite : 操作するFlxSprite
    • Left:Bool = true : 左端でラップするかどうか
    • Right:Bool = true : 右端でラップするかどうか
    • Top:Bool = true : 上でラップするかどうか
    • Bottom:Bool = true : 下でラップするかどうか
  • 戻り値: FlxSprite :引数で渡したFlxSprite

bound() : 指定の領域からFlxSpriteを出ないようにします

  • 引数
    • sprite:FlxSprite : 操作するFlxSprite
    • MinX:Float = 0 : 左上X座標
    • MinY:Float = 0 : 左上Y座標
    • MaxX:Float = 0 : 右下X座標 (0の場合はFlxG.width)
    • MaxY:Float = 0 : 右下Y座標 (0の場合はFlxG.height)
  • 戻り値: FlxSprite :引数で渡したFlxSprite

screenCenter() : 指定のFlxObjectを画面中央に配置します

  • 引数
    • object:FlxObject : 中央に配置するFlxObject
    • xAxis:Bool = true : X軸方向に中央揃えする
    • yAxis:Bool = true : Y軸方向に中央揃えする
  • 戻り値:FlxObject : 指定したFlxObject

drawLine() : FlxSpriteに線分を描画します

  • 引数
    • sprite:FlxSprite : 描画対象となるスプライト
    • StartX:Float : 開始座標(X)
    • StartY:Float : 開始座標(Y)
    • EndX:Float : 終端座標(X)
    • EndY:Float : 終端座標(Y)
    • ?lineStyle:LineStyle : 線の種類
    • ?drawStyle:DrawStyle : 描画方法
  • 戻り値:FlxSprite : 指定したFlxSprite

使用例

  var spr:FlxSprite;
  // 薄い白で1pxの太さの線
  var ls:LineStyle = {color:0x40FFFFFF, thickness:1};
  // スプライト(spr)に対して、(x1, y1)から(x2, y2)の線分を描画
  FlxSpriteUtil.drawLine(spr, x1, y1, x2, y2, ls);

drawRect() : FlxSpriteに矩形を描画します

drawCircle() : FlxSpriteに円を描画します

drawTriangle() : FlxSpriteに三角形を描画します

drawPolygon() : FlxSpriteに多角形を描画します

flicker() : レトロな明滅演出を開始します

  • 引数
    • Object:FlxObject : 明滅させるオブジェクト
    • Duration:Float = 1 : 明滅する秒。0を指定すると永遠に明滅する
    • Interval:Float = 0.04 : 明滅間隔
    • EndVisibility?:Bool = true : 明滅終了後に表示状態にするかどうか
    • ForceRestart?:Bool = true : 明滅中の場合にやり直すかどうか
    • ?CompletionCallback?:FlxFlicker->Void : 明滅完了後の呼び出されるコールバック関数
    • ?ProgressCallback?:FlxFlicker->Void : 明滅中に呼び出されるコールバック関数
  • 戻り値:FlxObject : 指定したオブジェクト

isFlickering() : 明滅中かどうかを判定します

  • 引数
    • Object:FlxObject : 判定するオブジェクト
  • 戻り値:Bool : 明滅中であればtrue

stopFlickering() : 明滅を終了します

  • 引数
    • Object:FlxObject : 明滅を終了するオブジェクト
  • 戻り値:FlxObject : 指定したオブジェクト

fadeIn() : FlxSpriteをフェードイン(透過から不透過)します

内部処理では FlxTween を呼び出しています
  • 引数
    • sprite:FlxSprite : フェードするスプライト
    • Duration:Float = 1 : フェード時間 (秒)
    • ?ResetAlpha?:Bool : 透明度を 0 から開始するかどうか
    • ?OnComplete?:TweenCallback? : フェード完了後に呼び出されるコールバック関数
  • 戻り値:FlxSprite : 引数に渡したsprite

fadeOut() : FlxSpriteをフェードアウト(不透過から透過)します

内部処理では FlxTween を呼び出しています
  • 引数
    • sprite:FlxSprite : フェードするスプライト
    • Duration:Float = 1 : フェード時間 (秒)
    • ?OnComplete?:TweenCallback? : フェード完了後に呼び出されるコールバック関数
  • 戻り値:FlxSprite : 引数に渡したsprite

LineStyle

  • ?thickness:Float : 線の太さ (0〜255) ※0を指定すると極細線
  • ?color:Int : 線の色 (ARGBカラー値)
  • ?pixelHinting:Bool : ヒンディングの有無 (線をくっきり描画するかどうか) ※デフォルトfalse
  • ?scaleMode:LineScaleMode? : スケールモード。デフォルトは"normal"
    文字列説明
    normal拡大縮小で線の太さを変える (デフォルト値)
    horisontal横方向のみ拡大縮小で線の太さを変える
    vertical縦方向のみ拡大縮小で線の太さを変える
    none拡大縮小で線の太さを変えない
  • ?capsStyle:CapsStyle? : 線先の種類
    文字列説明
    none線の先にキャップなし
    round線の先に丸いキャップをつける
    square線の先に四角いキャップをつける
  • ?jointStyle:JointStyle? : 角の種類 (連結した線分を描画するときのみ有効。通常は設定不要)
    文字列説明
    miter角をマイター結合 (尖らせる)
    bevel角をベベル結合 (折り曲げる)
    round角をラウンド結合 (丸くする)
  • ?miterLimit:Float : マイターの尖りの延長サイズ (1.0〜)

DrawStyle

  • ?matrix:Matrix : 変換行列
  • ?colorTransform:ColorTransform : カラー調整
  • ?blendMode:BlendMode : ブレンドモード
  • ?clipRect:Rectangle : クリッピング領域
  • ?smoothing:Bool : スムージング有効フラグ