Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Character

キャラクタ

classdesc

キャラクタクラス

constructor
memberof

FrameWork

extends

FrameWork.Sprite

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Character(width: number, height: number, parent: Group): Character

  • コンストラクタ

    method
    name

    UIParts.Character#Character

    Parameters

    • width: number

      表示サイズ.幅

    • height: number

      表示サイズ.高さ

    • parent: Group

      親Group

    Returns Character

Properties

Protected animeIndex

animeIndex: number

Protected animePattern

animePattern: Array<number>

Protected animeTipWidth

animeTipWidth: number

backgroundColor

backgroundColor: string

The Entity background color. Must be provided in the same format as the CSS 'color' property.

type

String

charaIndex

charaIndex: number

debugColor

debugColor: string

The Entity debug color. Must be provided in the same format as the CSS 'color' property.

type

String

Protected dir

dir: Direction

Protected dirIndexs

dirIndexs: Array<number>

Protected fileName

fileName: string

frame

frame: number

Indizes of the frames to be displayed. Frames with same width and height as Sprite will be arrayed from upper left corner of the {@link enchant.Sprite#image} image. When a sequence of numbers is provided, the displayed frame will switch automatically. At the end of the array the sequence will restart. By setting a value within the sequence to null, the frame switching is stopped.

example

var sprite = new Sprite(32, 32); sprite.frame = [0, 1, 0, 2] //-> 0, 1, 0, 2, 0, 1, 0, 2,.. sprite.frame = [0, 1, 0, 2, null] //-> 0, 1, 0, 2, (2, 2,.. :stop)

type

Number|Array

height

height: number

The height of the Entity.

type

Number

image

image: Surface

Image displayed in the Sprite.

type

enchant.Surface

Protected imageTipWidth

imageTipWidth: number

Protected isRunAnime

isRunAnime: boolean

maxWaitCount

maxWaitCount: number

アニメーション間隔(Runメソッド呼び出し)

opacity

opacity: number

The transparency of this entity. Defines the transparency level from 0 to 1 (0 is completely transparent, 1 is completely opaque).

type

Number

originX

originX: number

The point of origin used for rotation and scaling.

type

Number

originY

originY: number

The point of origin used for rotation and scaling.

type

Number

rotation

rotation: number

Entity rotation angle (degree).

type

Number

scaleX

scaleX: number

Scaling factor on the x axis of this Entity.

type

Number

scaleY

scaleY: number

Scaling factor on the y axis of this Entity.

type

Number

touchEnabled

touchEnabled: boolean

Indicates whether or not this Entity can be touched.

type

Boolean

visible

visible: boolean

Indicates whether or not to display this Entity.

type

Boolean

Protected waitCount

waitCount: number

width

width: number

The width of the Entity.

type

Number

x

x: number

x coordinates of the Node.

type

Number

y

y: number

y coordinates of the Node.

type

Number

Accessors

AnimePattern

  • set AnimePattern(value: Array<number>): void

  • アニメーションパターン 初期値：[0,1]

    prop
    name

    UIParts.Character#Character

    Parameters

    • value: Array<number>

    Returns void

AnimeWidth

  • set AnimeWidth(value: number): void

  • アニメーションの幅 初期値：2

    prop
    name

    UIParts.Character#Character

    Parameters

    • value: number

    Returns void

Dir

DirIndexs

  • set DirIndexs(value: Array<number>): void

  • Dirプロパティに対応したY位置の配列 ※必ず4要素が必要 初期値：[0,1,2,3]

    prop
    name

    UIParts.Character#Character

    Parameters

    • value: Array<number>

    Returns void

FileName

  • set FileName(value: string): void

  • ファイル名プロパティ

    method
    name

    FrameWork.Sprite#Sprite

    Parameters

    • value: string

      ファイル名

    Returns void

Methods

Init

  • Init(): void

IsRunAnime

  • IsRunAnime(): boolean

  • アニメ処理の状態取得

    method
    name

    UIParts.Character#IsRunAnime

    Returns boolean

    実行中はtrue 停止中はfalse

ResumeAnime

  • ResumeAnime(): void

Run

  • Run(): boolean

Protected SetAnime

  • SetAnime(): boolean

  • アニメ実行

    method
    name

    UIParts.Character#SetAnime

    Returns boolean

    フレーム更新実施の可否

Protected SetFrame

  • SetFrame(): void

  • フレームの更新

    method
    name

    UIParts.Character#SetFrame

    Returns void

    フレーム更新実施の可否

SuspendAnime

  • SuspendAnime(): void

addEventListener

  • addEventListener(type: string, listener: function): void

  • Add a new event listener which will be executed when the event is dispatched.

    Parameters

    • type: string

      Type of the events.

    • listener: function

      Event listener to be added.

        • (e: Event): void

        • Parameters

          • e: Event

          Returns void

    Returns void

clearEventListener

  • clearEventListener(type: string): any

  • Clear all defined event listeners of a given type. If no type is given, all listeners will be removed.

    Parameters

    • type: string

      Type of the events.

    Returns any

disableCollection

  • disableCollection(): any

dispatchEvent

  • dispatchEvent(e: Event): any

  • Issue an event.

    Parameters

    • e: Event

      Event to be issued.

    Returns any

enableCollection

  • enableCollection(): any

getBoundingRect

  • getBoundingRect(): object

  • Returns object

    • height: number
    • left: number
    • top: number
    • width: number

getOrientedBoundingRect

  • getOrientedBoundingRect(): object

  • Returns object

    • leftBottom: number
    • leftTop: number
    • rightBottom: number
    • rightTop: number

intersect

  • intersect(other: Entity): boolean

  • Performs a collision detection based on whether or not the bounding rectangles are intersecting.

    Parameters

    • other: Entity

      An object like Entity, with the properties x, y, width, height, which are used for the collision detection.

    Returns boolean

    True, if a collision was detected.

moveBy

  • moveBy(x: any, y: any): any

  • Move the Node relative to its current position.

    Parameters

    • x: any

      x axis movement distance.

    • y: any

      y axis movement distance.

    Returns any

moveTo

  • moveTo(x: any, y: any): any

  • Move the Node to the given target location.

    Parameters

    • x: any

      Target x coordinates.

    • y: any

      Target y coordinates.

    Returns any

on

  • on(eventName: string, func: function): any

  • Synonym for addEventListener.

    see

    enchant.EventTarget#addEventListener

    Parameters

    • eventName: string
    • func: function
        • (arg: any): void

        • Parameters

          • arg: any

          Returns void

    Returns any

remove

  • remove(): any

removeEventListener

  • removeEventListener(type: string, listener: function): void

  • Delete an event listener.

    Parameters

    • type: string
    • listener: function

      Event listener to be deleted.

        • (e: Event): void

        • Parameters

          • e: Event

          Returns void

    Returns void

rotate

  • rotate(deg: number): any

  • Rotate this Entity.

    Parameters

    • deg: number

      Rotation angle (degree).

    Returns any

scale

  • scale(x: number, y: number): any

  • Enlarges or shrinks this Entity.

    Parameters

    • x: number

      Scaling factor on the x axis.

    • y: number

    Returns any

within

  • within(other: Entity, distance: number): boolean

  • Performs a collision detection based on distance from the Entity's central point.

    Parameters

    • other: Entity

      An object like Entity, with properties x, y, width, height, which are used for the collision detection.

    • distance: number

    Returns boolean

    True, if a collision was detected.

Generated using TypeDoc