JSDoc: Namespace: Utils

Source:

sg2d-utils.js, line 12

Members

(static) FLAG_ADD_BORDER_ALPHA

Флаг добавления прозрачной границы в спрайте.

Source:

sg2d-utils.js, line 25

See:

SG2D.Utils.createInBetweenTextures

Methods

(static) addBorderAlphaTextures(options)

Добавляет прозрачную границу к спрайту в 1 пиксель, благодаря чему PIXI сглаживает края спрайта при его вращении. Ширина и высота спрайта увеличиваются на 2 пикселя!

Parameters:

Name Type Description

options

object

Properties

Name	Type	Attributes	Default	Description
`textures`	Array.<string> \| Array.<PIXI.Texture>	<optional>	void 0	Список текстур. Если не задан, то берутся все текстуры с флагом _isFinalTexture=true
`qborder`	number	<optional>	1	Ограничитель допустимой толщины прозрачной рамки

Source:

sg2d-utils.js, line 286

(static) addMask(config) → {HTMLCanvasElement}

Создать спрайт-маску

Parameters:

Name Type Description

config

object

Properties

Name	Type	Attributes	Default	Description
`width`	Number	<optional>	SG2D.Utils.DEFAULT_WIDTH
`height`	Number	<optional>	SG2D.Utils.DEFAULT_HEIGHT
`iterate`	function			Итератор
`name`	function			Имя текстуры

Source:

sg2d-utils.js, line 173

Returns:

Type: HTMLCanvasElement

(static) createCanvas(widthopt, heightopt, flagopt)

Создаёт новый канвас. По умолчанию создаёт OffscreenCanvas

Parameters:

Name	Type	Attributes	Default	Description
`width`	Number	<optional>	SG2D.Utils.DEFAULT_WIDTH
`height`	Number	<optional>	SG2D.Utils.DEFAULT_HEIGHT
`flag`	Number	<optional>	0	SG2D.Utils.FLAG_CANVAS_OFFSCREEN \| SG2D.Utils.FLAG_CANVAS_ELEMENT

Source:

sg2d-utils.js, line 558

(static) createInBetweenTextures(config)

Создание промежуточных текстур для постепенного перехода одной текстуры в другую (без использования альфа-канала)

Parameters:

Name Type Description

config

object

Properties

Name	Type	Attributes	Default	Description
`start`	PIXI.Texture \| string
`end`	PIXI.Texture \| string
`name`	string			Имя промежуточной текстуры с подстановкой индекса вместо "%"
`count`	Number	<optional>	2
`flags`	Number	<optional>		Флаги: SG2D.Utils.FLAG_ADD_BORDER_ALPHA

Source:

sg2d-utils.js, line 356

(static) debounce(func, delay) → {function}

Вернёт функцию, которая выполнится только после истечения заданного промежутка времени за который не было обращений к ней

Parameters:

Name	Type	Description
`func`	function
`delay`	Number

Source:

sg2d-utils.js, line 596

Returns:

Type: function

(static) drawTextureToCanvas(texture, canvas, options)

Отрисовка текстуры в произвольный канвас

Parameters:

Name Type Description

texture string | PIXI.Texture

canvas HTMLElementCanvas

options

object

Properties

Name	Type	Attributes	Default	Description
`x`	Number	<optional>	0
`y`	Number	<optional>	0

Source:

sg2d-utils.js, line 156

(async, static) getTextureAsBlob(mTexture) → {Promise.<Blob>}

Получить текстуру как blob-объект

Parameters:

Name	Type	Description
`mTexture`	string \| PIXI.Texture

Source:

sg2d-utils.js, line 95

Returns:

Type: Promise.<Blob>

(static) getTextureAsCanvas(mTexture) → {HTMLCanvasElement}

Получить текстуру в виде отдельного CANVAS с нарисованной в нём текстурой. При повторном вызове возвращается созданный ранее CANVAS для текстуры

Parameters:

Name	Type	Description
`mTexture`	string \| PIXI.Texture

Source:

sg2d-utils.js, line 72

Returns:

Type: HTMLCanvasElement

(async, static) getTextureUrl(mTexture, flagOpenWindowopt) → {Promise.<string>|false}

Получить URL текстуры с base64 кодированием

Parameters:

Name	Type	Attributes	Default	Description
`mTexture`	string \| PIXI.Texture
`flagOpenWindow`	boolean	<optional>	false	Если true, то ссылка откроется в новом окне

Source:

sg2d-utils.js, line 127

Returns:

Type: Promise.<string> | false

(static) getTime() → {Number}

Получить время с точностью до мс. Распознаёт браузер и платформу NodeJS

Source:

sg2d-utils.js, line 32

Returns:

Type: Number

(static) ifUndefined(value, valueIfUndefined) → {value|valueIfUndefined}

Вернёт valueIfUndefined, если value===undefined

Parameters:

Name	Type	Description
`value`	mixed
`valueIfUndefined`	mixed

Source:

sg2d-utils.js, line 682

Returns:

Type: value | valueIfUndefined

(static) isEmpty(o) → {Boolean}

Проверить - объект пустой или нет

Parameters:

Name	Type	Description
`o`	object

Source:

sg2d-utils.js, line 644

Returns:

Type: Boolean

(static) loadJS(src, onloadopt) → {Promise}

Динамическая загрузка и выполнение скриптов

Parameters:

Name	Type	Attributes	Description
`src`	string		Путь
`onload`	function	<optional>	Вызывается после загрузки скрипта, но перед его выполнением

Source:

sg2d-utils.js, line 53

Returns:

Type: Promise

(static) objectForEach(obj, callback, context) → {undefined}

forEach для объекта

Parameters:

Name	Type	Description
`obj`	object
`callback`	function
`context`	object

Source:

sg2d-utils.js, line 657

Returns:

Type: undefined

(static) parseTexturePack(resources)

Текстуры, в названии которых указан размер по шаблону "_%x%", автоматически распиливаются на составные текстуры с добавлением индекса.

Parameters:

Name	Type	Description
`resources`	object	Объект, выдаваемый движком PIXI при загрузке ресурсов (см. PIXI.Loader.load(loader, resources)=>{...})

Source:

sg2d-utils.js, line 474

(static) propertiesCount(o) → {Number}

Количество собственных свойст в объекте

Parameters:

Name	Type	Description
`o`	object

Source:

sg2d-utils.js, line 669

Returns:

Type: Number

(static) PXtoCX(x_or_y) → {Number}

Преобразовать пиксели в кластеры (единица измерения)

Parameters:

Name	Type	Description
`x_or_y`	Number

Source:

sg2d-utils.js, line 585

Returns:

Type: Number

(static) setBorderAlphaTexture(options)

Сделать границу заданного спрайта полупрозрачной (чтобы исключить артефакты в виде полос по краям тайлов ландшафта)

Parameters:

Name Type Description

options

object

Properties

Name	Type	Attributes	Default	Description
`texture`	PIXI.Texture \| string
`alpha`	number	<optional>	0.995	Прозрачность самой внешней границы (1 пиксель от края)
`alpha2`	number	<optional>	1	Прозрачность границы 2 пикселя от края

Source:

sg2d-utils.js, line 243

(static) setBorderAlphaTextures(options)

Сделать границу спрайтов полупрозрачной (чтобы исключить артефакты в виде полос по краям тайлов ландшафта)

Parameters:

Name Type Description

options

object

Properties

Name	Type	Attributes	Default	Description
`textures`	Array.<string> \| Array.<PIXI.Texture>	<optional>	void 0	Список текстур. Если не задан, то берутся все текстуры с флагом _isFinalTexture=true
`alpha`	number	<optional>	0.995	Прозрачность самой внешней границы (1 пиксель от края)
`alpha2`	number	<optional>	1	Прозрачность границы 2 пикселя от края

Source:

sg2d-utils.js, line 217

(static) throttle(func, limit, _contextopt) → {function}

Вернёт функцию, которая будет выполнятся не чаще одного раза в заданный промежуток времени

Parameters:

Name	Type	Attributes	Default	Description
`func`	function
`limit`	type			Время задержки
`_context`	object	<optional>	this

Source:

sg2d-utils.js, line 614

Returns:

Type: function