Руководство API скрипты

VisualEffect

класс в UnityEngine.VFX / Наследует от: Behaviour

Описание

Класс визуальных эффектов, который ссылается на экземпляр VisualEffectAsset в сцене.

Свойства

aliveParticleCount Возвращает сумму всех живых частиц в пределах визуального эффекта.
culled Используйте это свойство, чтобы определить, виден ли этот визуальный эффект ни с какой камеры. (Только чтение)
initialEventID Идентификатор имени события по умолчанию. Чтобы получить это значение, используйте Shader.PropertyID после пробуждения VisualEffect или после вызова VisualEffect.Reinit.
initialEventName Имя события по умолчанию. Unity вызывает это событие при пробуждении VisualEffect или при вызове VisualEffect.Reinit.
outputEventReceived О выходных событиях сообщается через этот обратный вызов.
pause Используйте это свойство, чтобы установить состояние паузы визуального эффекта.
playRate Множитель, который Unity применяет к дельта-времени при обновлении VisualEffect. Значение по умолчанию — 1,0f.
resetSeedOnPlay Это свойство определяет, будет ли визуальный эффект создавать новое начальное значение для генератора случайных чисел при каждом вызове функции VisualEffect.Play.
startSeed Исходное начальное число, используемое для внутреннего генератора случайных чисел.
visualEffectAsset VisualEffectAsset, который использует VisualEffect.

Конструкторы

VisualEffect Конструктор VisualEffect.

Публичные Методы

AdvanceOneFrame Если VisualEffect.pause имеет значение true, этот метод обрабатывает следующее обновление визуального эффекта ровно для одного кадра с текущей разницей во времени.
CreateVFXEventAttribute Используйте этот метод для создания нового атрибута VFXEventAttribute.
GetAnimationCurve Получает значение именованного свойства кривой анимации.
GetBool Получает значение именованного логического свойства
GetFloat Получает значение именованного свойства с плавающей запятой
GetGradient Получает значение именованного свойства градиента
GetInt Получите именованное открытое целое число.
GetMatrix4x4 Получает значение именованного свойства Matrix4x4.
GetMesh Получает значение именованного свойства сетки
GetOutputEventNames Получает имя каждой системы выходных событий.
GetParticleSystemInfo Получает информацию о системе частиц.
GetParticleSystemNames Получает имя каждой системы частиц.
GetSpawnSystemInfo Получает состояние системы спавна.
GetSpawnSystemNames Получает имя каждой системы спавна.
GetSystemNames Получает имя каждой системы.
GetTexture Получает значение именованного свойства текстуры
GetTextureDimension Получает ожидаемый размер текстуры для именованной открытой текстуры.
GetUInt Получает значение именованного целочисленного свойства без знака
GetVector2 Получает значение именованного свойства Vector2
GetVector3 Получает значение именованного свойства Vector3
GetVector4 Получает значение именованного свойства Vector4
HasAnimationCurve Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить кривую анимации с переданным вами именем.
HasBool Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить логическое значение с переданным вами именем.
HasFloat Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить значение с плавающей запятой с переданным вами именем.
HasGradient Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить градиент с переданным вами именем.
HasInt Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить целое число с переданным вами именем.
HasMatrix4x4 Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить Matrix4x4 с переданным вами именем.
HasMesh Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить сетку с именем, которое вы передаете.
HasSystem Используйте эту функцию, чтобы определить, имеет ли VisualEffect систему, которую вы передаете..
HasTexture Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить текстуру с переданным вами именем.
HasUInt Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить целое число без знака с переданным вами именем.
HasVector2 Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить Vector2 с переданным вами именем.
HasVector3 Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить Vector3 с переданным вами именем.
HasVector4 Используйте этот метод, чтобы проверить, может ли визуальный эффект переопределить Vector4 с переданным вами именем.
Play Используйте этот метод для отправки события воспроизведения в каждую систему Spawn.
Reinit Повторно инициализируйте визуальный эффект.
ResetOverride Используйте этот метод, чтобы установить для переопределенного состояния значение false. Это восстанавливает значение по умолчанию, указанное для ресурса визуальных эффектов.
SendEvent Используйте этот метод для отправки пользовательского именованного события.
SetAnimationCurve Новое значение кривой анимации.
SetBool Новое логическое значение.
SetFloat Новое значение с плавающей запятой.
SetGradient Новое значение градиента.
SetInt Новое целочисленное значение.
SetMatrix4x4 Новое значение Matrix4x4.
SetMesh Новое значение сетки.
SetTexture Новое значение текстуры.
SetUInt Новое целочисленное значение без знака.
SetVector2 Новое значение Vector2.
SetVector3 Новое значение Vector3.
SetVector4 Новое значение Vector4.
Simulate Используйте этот метод, чтобы ускорить визуальный эффект, имитируя все системы для нескольких шагов, используя указанное дельта-время.
Stop Используйте этот метод для отправки события остановки во все системы Spawn.

Унаследованные члены

Свойства

enabled Включенные поведения обновляются, отключенные — нет.
isActiveAndEnabled Было ли поведение активным и включенным?
gameObject Игровой объект, к которому прикреплен компонент. Компонент всегда привязан к игровому объекту.
tag Тег игрового объекта.
transform Transform, прикрепленный игровому объекту.
hideFlags Должен ли объект быть скрыт, сохранен вместе со сценой или изменен пользователем?
name Имя объекта

Публичные Методы

BroadcastMessage Вызывает метод с именем methodName для каждого MonoBehaviour в игровом объекте или любом из его дочерних элементов.
CompareTag Помечен ли этот игровой объект тегом?
GetComponent Возвращает компонент, если он прикреплён к игровому объекту, и null, если нет. Также возвращает отключенные компоненты.
GetComponentInChildren Возвращает компонент дочернего элемента игрового объекта, используя поиск в глубину.
GetComponentInParent Возвращает компонент игрового объекта в любом из его родителей.
GetComponents Возвращает все компоненты игрового объекта
GetComponentsInChildren Возвращает все компоненты дочерних элементов игрового объекта. Работает рекурсивно.
GetComponentsInParent Возвращает все компоненты игрового объекта любого из родителя.
SendMessage Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте.
SendMessageUpwards Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте и для каждого behaviour.
TryGetComponent Получает компонент указанного типа, если он существует.
GetInstanceID Возвращает идентификатор экземпляра объекта.
ToString Возвращает имя объекта.

Статические Методы

Destroy Удаляет игровой объект, компонент или актив.
DestroyImmediate Уничтожает объект obj. Настоятельно рекомендуется использовать Destroy.
DontDestroyOnLoad Не уничтожает целевой объект при загрузке новой сцены.
FindObjectOfType Возвращает первый активный загруженный объект.
FindObjectsOfType Получает список всех загруженных объектов.
Instantiate Клонирует исходный объект и возвращает клон.

Операторы

bool Объект существует?
operator != Сравнивает, ссылаются ли два объекта на другой объект.
operator == Сравнивает две ссылки на объекты, чтобы определить, ссылаются ли они на один и тот же объект.
Вы можете отблагодарить автора, за перевод документации на русский язык. Донат
API скрипты 2021.3