Spec-Zone.ru › Phaser

Класс: Phaser.Utils.Debug

Конструктор

new Debug(game)

Коллекция методов для отображения отладочной информации о игровых объектах.

Если ваша игра запущена в режиме Canvas, то все методы Debug следует вызывать из
вашей функции render. Это происходит потому, что они отрисовываются непосредственно на игровом холсте,
поэтому если вы вызовете какие-либо методы отладки за пределами render , они, скорее всего, будут перезаписаны
самой игрой.

Если ваша игра запущена в режиме WebGL, Debug создаст объект Sprite, который будет размещен в верхней части списка отображения Stage и привяжет к нему текстуру холста,
которую необходимо загружать каждый кадр. Обратите внимание: это очень затратно, особенно в браузерах, таких как Firefox. Поэтому включение отладки
в режиме WebGL следует выполнять только в том случае, если это действительно необходимо (или ваш компьютер способен справиться с этим) и отключить её для производства!

Параметры
Имя Тип Описание
game Phaser.Game

Ссылка на запущенную игру.

Исходный код: utils/Debug.js (Строка 23)

Общедоступные свойства

bmd : Phaser.BitmapData

В режиме WebGL эта BitmapData содержит копию холста отладки.

Исходный код: utils/Debug.js (Строка 38)

canvas :HTMLCanvasElement

Холст, на который Debug выполняет отрисовку.

Исходный код: utils/Debug.js (Строка 43)

columnWidth : number

Интервал между столбцами.

Исходный код: utils/Debug.js (Строка 59)

context :CanvasRenderingContext2D

Контекст 2D холста.

Исходный код: utils/Debug.js (Строка 48)

currentAlpha : number

Альфа-канал контекста Debug, устанавливаемый перед отрисовкой всей отладочной информации.

Значение по умолчанию
  • 1
Исходный код: utils/Debug.js (Строка 87)

currentX : number

Текущая координата X, в которой будет отрисована информация отладки.

Исходный код: utils/Debug.js (Строка 75)

currentY : number

Текущая координата Y, в которой будет отрисована информация отладки.

Исходный код: utils/Debug.js (Строка 81)

dirty : boolean

Необходимо ли перерисовать холст?

Исходный код: utils/Debug.js (Строка 92)

font : string

Шрифт, которым отображается отладочная информация.

Значение по умолчанию
  • '14px Courier'
Исходный код: utils/Debug.js (Строка 54)

game : Phaser.Game

Ссылка на запущенную игру.

Исходный код: utils/Debug.js (Строка 28)

lineHeight : number

Высота строки между текстом отладки.

Исходный код: utils/Debug.js (Строка 64)

renderShadow : boolean

Отображать ли текст с легкой тенью? Это упрощает чтение на различных типах фона.

Исходный код: utils/Debug.js (Строка 69)

sprite : Phaser.Image

Если отладка выполняется в режиме WebGL, нам нужен этот элемент.

Исходный код: utils/Debug.js (Строка 33)

Общедоступные методы

body(sprite, color, filled)

Отобразить физическое тело Sprites, если оно задано. Тело отображается как заполненный или контурный прямоугольник.
Это работает только для физики Arcade, Ninja Physics (только AABB и Circle) и Box2D.
Чтобы отобразить физическое тело P2, необходимо включить режим отладки при его создании.

Parameters
Name Type Argument Default Description
sprite Phaser.Sprite

Sprite, чье тело будет отображено.

color string <optional>
'rgba(0,255,0,0.4)'

Цвет отладочного прямоугольника для отображения. Формат — строка CSS цвета, например '#ff0000' или 'rgba(255,0,0,0.5)'.

filled boolean <optional>
true

Отобразить тело как заполненный прямоугольник (true) или прямоугольник с контуром (false)

Source code: utils/Debug.js (Line 747)

bodyInfo(sprite, x, y, color)

Отображение информации о физическом теле Sprites.

Parameters
Name Type Argument Default Description
sprite Phaser.Sprite

Отображаемый sprite.

x number

Положение X отладочной информации для отображения.

y number

Положение Y отладочной информации для отображения.

color string <optional>
'rgb(255,255,255)'

Цвет отладочной информации для отображения (формат — строка CSS цвета).

Source code: utils/Debug.js (Line 781)

<internal> boot()

Внутренний метод, запускающий отображение отладки.

Internal:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Source code: utils/Debug.js (Line 98)

box2dBody(sprite, color)

Отображает данные 'debug draw' для данного тела Box2D.
Используется стандартная функция отладки рисования Box2D, поэтому цвета определяются движком Box2D.

Parameters
Name Type Argument Default Description
sprite Phaser.Sprite

Sprite, чье тело будет отображено.

color string <optional>
'rgb(0,255,0)'

Цвет отладочной информации для отображения (формат — строка CSS цвета).

Source code: utils/Debug.js (Line 828)

box2dWorld()

Отображает данные 'debug draw' для мира Box2D, если он существует.
Используется стандартная функция отладки рисования Box2D, поэтому цвета определяются движком
Box2D.

Source code: utils/Debug.js (Line 810)

cameraInfo(camera, x, y, color)

Отображение информации о камере, включая размеры и положение.

Parameters
Name Type Argument Default Description
camera Phaser.Camera

Phaser.Camera, для которой отображается отладочная информация.

x number

Положение X отладочной информации для отображения.

y number

Положение Y отладочной информации для отображения.

color string <optional>
'rgb(255,255,255)'

Цвет отладочной информации для отображения (формат — строка CSS цвета).

Source code: utils/Debug.js (Line 285)

destroy()

Уничтожить этот объект.

Source code: utils/Debug.js (Line 877)

geom(object, color, filled)

Отобразить прямоугольник.

Parameters
Name Type Argument Default Description
object Phaser.Rectangle | object

Объект геометрии для отображения.

color string <optional>

Цвет отладочной информации для отображения (формат — строка CSS цвета).

filled boolean <optional>
true

Отобразить объект как заполненный (по умолчанию, true) или контурный (false)

Source code: utils/Debug.js (Line 645)

geom(object, color, filled, forceType)

Отображение геометрического объекта Phaser, включая Rectangle, Circle, Point или Line.

Parameters
Имя Тип Аргумент Значение по умолчанию Описание
object Phaser.Rectangle | Phaser.Circle | Phaser.Point | Phaser.Line

Объект геометрии для отрисовки.

color string <optional>

Цвет отладочной информации для отрисовки (формат — строка цвета CSS).

filled boolean <optional>
true

Отрисовать объект как заполненный (по умолчанию, true) или контурным (false).

forceType number <optional>
0

Принудительно задать тип отрисовки. Если 0, тип не будет принудительно задан, в противном случае 1 = Прямоугольник, 2 = Окружность, 3 = Точка и 4 = Линия.

Исходный код: utils/Debug.js (Строка 580)

inputInfo(x, y, color)

Отрисовка отладочной информации об объекте Input.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
x number

Позиция X отладочной информации для отрисовки.

y number

Позиция Y отладочной информации для отрисовки.

color string <optional>
'rgb(255,255,255)'

Цвет отладочной информации для отрисовки. (формат — строка цвета CSS).

Исходный код: utils/Debug.js (Строка 433)

key(key, x, y, color)

Отрисовка информации об объекте Phaser.Key.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
key Phaser.Key

Ключ для отрисовки информации.

x number

Позиция X отладочной информации для отрисовки.

y number

Позиция Y отладочной информации для отрисовки.

color string <optional>
'rgb(255,255,255)'

Цвет отладочной информации для отрисовки. (формат — строка цвета CSS).

Исходный код: utils/Debug.js (Строка 412)

<internal> line()

Внутренний метод, выводящий одну строку текста, разделяя ее по необходимым столбцам, по одному на параметр.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: utils/Debug.js (Строка 226)

lineInfo(line, x, y, color)

Отрисовка информации о линии в заданном цвете.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
line Phaser.Line

Линия для отображения данных.

x number

Позиция X отладочной информации для отрисовки.

y number

Позиция Y отладочной информации для отрисовки.

color string <optional>
'rgb(255,255,255)'

Цвет отладочной информации для отрисовки. (формат — строка цвета CSS).

Исходный код: utils/Debug.js (Строка 541)

pixel(x, y, color, size)

Отрисовка одного пикселя заданного размера.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
x number

Позиция X пикселя для отрисовки.

y number

Позиция Y пикселя для отрисовки.

color string <optional>

Цвет пикселя (формат — строка цвета CSS).

size number <optional>
2

Размер пикселя для отрисовки.

Исходный код: utils/Debug.js (Строка 560)

pointer(pointer, hideIfUp, downColor, upColor, color)

Отображает объект Phaser.Pointer.circle на сцене зелёным цветом при нажатии и красным при отпускании, а также отладочный текст.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
pointer Phaser.Pointer

Указатель, который вы хотите отобразить.

hideIfUp boolean <optional>
false

Не отрисовывать окружность, если указатель отпущен.

downColor string <optional>
'rgba(0,255,0,0.5)'

Цвет окружности при нажатии.

upColor string <optional>
'rgba(255,0,0,0.5)'

Цвет окружности при отпускании (если hideIfUp — false).

color string <optional>
'rgb(255,255,255)'

Цвет отладочной информации для отрисовки. (формат — строка цвета CSS).

Source code: utils/Debug.js (Line 331)

<internal> preUpdate()

Внутренний метод, очищающий холст (если это Sprite) в подготовке к новой сессии отладки.

Внутренний:
  • Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
Source code: utils/Debug.js (Line 143)

quadTree(quadtree, color)

Визуализирует дерево QuadTree на экране.

Parameters
Имя Тип Описание
quadtree Phaser.QuadTree

Дерево QuadTree для визуализации.

color string

Цвет линий в дереве QuadTree.

Source code: utils/Debug.js (Line 707)

reset()

Очищает холст отладки.

Source code: utils/Debug.js (Line 162)

<internal> resize(scaleManager, width, height)

Внутренний метод, изменяющий размер BitmapData и холста.
Вызывается ScaleManager.onSizeChange только в режиме WebGL.

Parameters
Имя Тип Описание
scaleManager Phaser.ScaleManager

Менеджер масштабирования Phaser.

width number

Новая ширина игры.

height number

Новая высота игры.

Внутренний:
  • Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
Source code: utils/Debug.js (Line 124)

ropeSegments(rope, color, filled)

Отображает сегменты каната Rope. Примечание: это очень ресурсоёмко, так как приходится рассчитывать новые сегменты каждый раз при вызове.

Parameters
Имя Тип Аргумент Значение по умолчанию Описание
rope Phaser.Rope

Канат, для которого отображаются сегменты.

color string <optional>

Цвет информации отладки (формат — строка CSS цвета).

filled boolean <optional>
true

Отображать прямоугольник с заливкой (по умолчанию, true) или обводкой (false).

Source code: utils/Debug.js (Line 472)

soundInfo(sound, x, y, color)

Отображает информацию о звуке, включая состояние декодирования, длительность, громкость и многое другое.

Parameters
Имя Тип Аргумент Значение по умолчанию Описание
sound Phaser.Sound

Объект звука для отладки.

x number

Позиция X отображаемой информации отладки.

y number

Позиция Y отображаемой информации отладки.

color string <optional>
'rgb(255,255,255)'

Цвет отображаемой информации отладки (формат — строка CSS цвета).

Source code: utils/Debug.js (Line 254)

spriteBounds(sprite, color, filled)

Отображает границы Sprite. Примечание: это очень ресурсоёмко, так как границы приходится рассчитывать каждый раз при вызове!

Parameters
Имя Тип Аргумент Значение по умолчанию Описание
sprite Phaser.Sprite | Phaser.Image

Sprite, для которого отображаются границы.

color string <optional>

Цвет отображаемой информации отладки (формат — строка CSS цвета).

filled boolean <optional>
true

Отображать прямоугольник с заливкой (по умолчанию, true) или обводкой (false).

Source code: utils/Debug.js (Line 453)

spriteCoords(sprite, x, y, color)

Отображает координаты Sprite в локальной, позиционной и мировой системах координат.

Parameters
Имя Тип Аргумент Значение по умолчанию Описание
sprite Phaser.Sprite | Phaser.Image

Sprite, для которого отображаются координаты.

x number

Позиция X отображаемой информации отладки.

y number

Позиция Y отображаемой информации отладки.

color string <optional>
'rgb(255,255,255)'

Цвет отображаемой информации отладки (формат — строка CSS цвета).

Source code: utils/Debug.js (Line 515)

spriteInfo(sprite, x, y, color)

Отображает информацию отладки (включая имя, информацию о границах, позиции и другие свойства) о Sprite.

Parameters
Имя Тип Аргумент По умолчанию Описание
sprite Phaser.Sprite

Объект Sprite, для которого отображается информация.

x число

Положение X отладочной информации для отрисовки.

y число

Положение Y отладочной информации для отрисовки.

color строка <необязательно>
'rgb(255,255,255)'

Цвет отладочной информации для отрисовки. (формат — строка CSS цвета).

Исходный код: utils/Debug.js (Строка 492)

spriteInputInfo(sprite, x, y, color)

Отобразить отладочную информацию о вводе Sprite.

Параметры
Имя Тип Аргумент По умолчанию Описание
sprite Phaser.Sprite | Phaser.Image

Sprite, для которого отображаются данные ввода.

x число

Положение X отладочной информации для отрисовки.

y число

Положение Y отладочной информации для отрисовки.

color строка <необязательно>
'rgb(255,255,255)'

Цвет отладочной информации для отрисовки. (формат — строка CSS цвета).

Исходный код: utils/Debug.js (Строка 391)

<внутренний> start(x, y, color, columnWidth)

Внутренний метод, который сбрасывает и запускает значения отладочного вывода.

Параметры
Имя Тип Аргумент По умолчанию Описание
x число <необязательно>
0

Значение X, с которого будет начинаться отладочная информация.

y число <необязательно>
0

Значение Y, с которого будет начинаться отладочная информация.

color строка <необязательно>
'rgb(255,255,255)'

Цвет отладочного текста.

columnWidth число <необязательно>
0

Отступ между столбцами.

Внутренний:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: utils/Debug.js (Строка 181)

<внутренний> stop()

Внутренний метод, который останавливает вывод отладки.

Внутренний:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: utils/Debug.js (Строка 214)

text(text, x, y, color, font)

Отрисовать строку текста.

Параметры
Имя Тип Аргумент Описание
text строка

Строка текста для отрисовки.

x число

Положение X отладочной информации для отрисовки.

y число

Положение Y отладочной информации для отрисовки.

color строка <необязательно>

Цвет отладочной информации для отрисовки (формат — строка CSS цвета).

font строка <необязательно>

Шрифт текста для отрисовки.

Исходный код: utils/Debug.js (Строка 676)

timer(timer, x, y, color)

Отобразить информацию таймера.

Параметры
Имя Тип Аргумент По умолчанию Описание
timer Phaser.Timer

Таймер Phaser.Timer, для которого отображается отладочная информация.

x число

Положение X отладочной информации для отрисовки.

y число

Положение Y отладочной информации для отрисовки.

color строка <необязательно>
'rgb(255,255,255)'

Цвет отладочной информации для отрисовки. (формат — строка CSS цвета).

Исходный код: utils/Debug.js (Строка 312)

© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Utils.Debug.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API