TileData
Настройки для одного тайла в TileSet.
Настройки для одного тайла в TileSet.
Объект TileData представляет отдельный тайл в TileSet. Обычно он редактируется с помощью редактора тайлсетов, но может быть изменён во время выполнения с помощью TileMapLayer._TileDataRuntimeUpdate.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Конструкторы1
TileDataКонструктор
public TileData();Свойства11
FlipHСвойство
public bool FlipH { get; set; }Если true, текстура тайла будет перевернута по горизонтали.
FlipVСвойство
public bool FlipV { get; set; }Если true, текстура тайла будет перевернута по вертикали.
MaterialСвойство
public Material Material { get; set; }Material для использования с этим TileData. Это может быть CanvasItemMaterial для использования шейдера по умолчанию или ShaderMaterial для использования пользовательского шейдера.
ModulateСвойство
public Color Modulate { get; set; }Color Модификация плитки.
ProbabilityСвойство
public float Probability { get; set; }Относительная вероятность выбора этого тайла при рисовании шаблона из случайных тайлов.
TerrainСвойство
public int Terrain { get; set; }Идентификатор ландшафта из набора ландшафта, который использует тайл.
TerrainSetСвойство
public int TerrainSet { get; set; }Идентификатор набора ландшафта, который использует тайл.
TextureOriginСвойство
public Vector2I TextureOrigin { get; set; }Смещает позицию, где отображается тайл.
TransposeСвойство
public bool Transpose { get; set; }Если true, тайл будет отображаться транспонированным, т. е. с поменянными местами горизонтальной и вертикальной текстурой UV.
YSortOriginСвойство
public int YSortOrigin { get; set; }Вертикальная точка тайла, используемая для определения порядка сортировки по оси Y.
ZIndexСвойство
public int ZIndex { get; set; }Индекс порядка этого тайла относительно TileMapLayer.
Методы57
AddCollisionPolygonvoid
public void AddCollisionPolygon(int layerId);Добавляет полигон столкновения к тайлу на указанном физическом слое TileSet.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
AddOccluderPolygonvoid
public void AddOccluderPolygon(int layerId);Добавляет многоугольник окклюзии к тайлу на слое окклюзии TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
GetCollisionPolygonOneWayMarginfloat
public float GetCollisionPolygonOneWayMargin(int layerId, int polygonIndex);Возвращает одностороннее поле (для односторонних платформ) полигона с индексом polygon_index для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
floatGetCollisionPolygonPointsVector2[]
public Vector2[] GetCollisionPolygonPoints(int layerId, int polygonIndex);Возвращает точки полигона с индексом polygon_index для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
Vector2[]GetCollisionPolygonsCountint
public int GetCollisionPolygonsCount(int layerId);Возвращает количество полигонов тайла для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
intGetConstantAngularVelocityfloat
public float GetConstantAngularVelocity(int layerId);Возвращает постоянную угловую скорость, применяемую к объектам при столкновении с этим тайлом.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
floatGetConstantLinearVelocityVector2
public Vector2 GetConstantLinearVelocity(int layerId);Возвращает постоянную линейную скорость, применяемую к объектам при столкновении с этим тайлом.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
Vector2GetCustomDataVariant
public Variant GetCustomData(string layerName);Читает Variant из именованного слоя пользовательских данных TileSet. Слой и его тип задаются в TileSet заранее. Это метаданные типа тайла; например walkable сам по себе не включает навигацию и не выключает физическую форму.
| Имя | Тип | По умолчанию |
|---|---|---|
layerName | string | — |
layerNameТочное имя существующего слоя пользовательских данных, а не ID клетки. При сомнении проверьте HasCustomData.
VariantЗначение Variant. Для bool-слоя примера используйте AsBool после проверки данных. При неизвестном имени движок сообщает ошибку и возвращает Nil; Nil не следует молча считать корректным false.
GetCustomDataByLayerIdVariant
public Variant GetCustomDataByLayerId(int layerId);Возвращает пользовательское значение данных для пользовательского слоя данных с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
VariantGetFlipHbool
public bool GetFlipH();boolGetFlipVbool
public bool GetFlipV();boolGetMaterialMaterial
public Material GetMaterial();MaterialGetModulateColor
public Color GetModulate();ColorGetNavigationPolygon2 перегрузки
public NavigationPolygon GetNavigationPolygon(int _UnnamedArg0);Возвращает навигационный полигон тайла для навигационного слоя TileSet с индексом layer_id.
TileData.FlipH, TileData.FlipV и TileData.Transpose позволяют преобразовать возвращаемый полигон.
| Имя | Тип | По умолчанию |
|---|---|---|
_UnnamedArg0 | int | — |
NavigationPolygonGetOccluder2 перегрузки · Есть устаревшие
public OccluderPolygon2D GetOccluder(int _UnnamedArg0);Возвращает окклюдерный полигон тайла для слоя окклюзии TileSet с индексом layer_id.
TileData.FlipH, TileData.FlipV и TileData.Transpose позволяют преобразовать возвращаемый полигон.
| Имя | Тип | По умолчанию |
|---|---|---|
_UnnamedArg0 | int | — |
OccluderPolygon2Dpublic OccluderPolygon2D GetOccluder(int layerId, bool flipH = false, bool flipV = false, bool transpose = false);Возвращает окклюдерный полигон тайла для слоя окклюзии TileSet с индексом layer_id.
TileData.FlipH, TileData.FlipV и TileData.Transpose позволяют преобразовать возвращаемый полигон.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
flipH | bool | false |
flipV | bool | false |
transpose | bool | false |
OccluderPolygon2DGetOccluderPolygonOccluderPolygon2D
public OccluderPolygon2D GetOccluderPolygon(int layerId, int polygonIndex, bool flipH = false, bool flipV = false, bool transpose = false);Возвращает многоугольник окклюдера с индексом polygon_index из слоя окклюзии TileSet с индексом layer_id.
Параметры TileData.FlipH, TileData.FlipV и TileData.Transpose могут быть true для преобразования возвращаемого многоугольника.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
flipH | bool | false |
flipV | bool | false |
transpose | bool | false |
OccluderPolygon2DGetOccluderPolygonsCountint
public int GetOccluderPolygonsCount(int layerId);Возвращает количество окклюдерных полигонов тайла в слое окклюзии TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
intGetProbabilityfloat
public float GetProbability();floatGetTerrainint
public int GetTerrain();intGetTerrainPeeringBitint
public int GetTerrainPeeringBit(TileSet.CellNeighbor peeringBit);Возвращает бит ландшафа тайла для заданного направления peering_bit. Для проверки корректности направления используйте TileData.IsValidTerrainPeeringBit.
| Имя | Тип | По умолчанию |
|---|---|---|
peeringBit | TileSet.CellNeighbor | — |
intGetTerrainSetint
public int GetTerrainSet();intGetTextureOriginVector2I
public Vector2I GetTextureOrigin();Vector2IGetTransposebool
public bool GetTranspose();boolGetYSortOriginint
public int GetYSortOrigin();intGetZIndexint
public int GetZIndex();intHasCustomDatabool
public bool HasCustomData(string layerName);Возвращает информацию о существовании пользовательского слоя данных с именем layer_name.
| Имя | Тип | По умолчанию |
|---|---|---|
layerName | string | — |
boolIsCollisionPolygonOneWaybool
public bool IsCollisionPolygonOneWay(int layerId, int polygonIndex);Возвращает информацию о том, включены ли односторонние столкновения для полигона с индексом polygon_index для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
boolIsValidTerrainPeeringBitbool
public bool IsValidTerrainPeeringBit(TileSet.CellNeighbor peeringBit);Возвращает, является ли заданное направление peering_bit допустимым для этого тайла.
| Имя | Тип | По умолчанию |
|---|---|---|
peeringBit | TileSet.CellNeighbor | — |
boolRemoveCollisionPolygonvoid
public void RemoveCollisionPolygon(int layerId, int polygonIndex);Удаляет полигон с индексом polygon_index для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
RemoveOccluderPolygonvoid
public void RemoveOccluderPolygon(int layerId, int polygonIndex);Удаляет полигон с индексом polygon_index для слоя окклюзии TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
SetCollisionPolygonOneWayvoid
public void SetCollisionPolygonOneWay(int layerId, int polygonIndex, bool oneWay);Включает/отключает односторонние столкновения на полигоне с индексом polygon_index для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
oneWay | bool | — |
SetCollisionPolygonOneWayMarginvoid
public void SetCollisionPolygonOneWayMargin(int layerId, int polygonIndex, float oneWayMargin);Устанавливает одностороннюю границу (для односторонних платформ) полигона с индексом polygon_index для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
oneWayMargin | float | — |
SetCollisionPolygonPoints2 перегрузки
public void SetCollisionPolygonPoints(int layerId, int polygonIndex, Vector2[] polygon);Устанавливает точки полигона с индексом polygon_index для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
polygon | Vector2[] | — |
public void SetCollisionPolygonPoints(int layerId, int polygonIndex, ReadOnlySpan<Vector2> polygon);Устанавливает точки полигона с индексом polygon_index для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
polygon | ReadOnlySpan<Vector2> | — |
SetCollisionPolygonsCountvoid
public void SetCollisionPolygonsCount(int layerId, int polygonsCount);Устанавливает количество полигонов для физического слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonsCount | int | — |
SetConstantAngularVelocityvoid
public void SetConstantAngularVelocity(int layerId, float velocity);Устанавливает постоянную угловую скорость. Не вращает тайл. Эта угловая скорость применяется к объектам, сталкивающимся с этим тайлом.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
velocity | float | — |
SetConstantLinearVelocityvoid
public void SetConstantLinearVelocity(int layerId, Vector2 velocity);Устанавливает постоянную линейную скорость. Не перемещает тайл. Эта линейная скорость применяется к объектам, сталкивающимся с этим тайлом. Это полезно для создания конвейерных лент.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
velocity | Vector2 | — |
SetCustomDatavoid
public void SetCustomData(string layerName, Variant value);Устанавливает пользовательское значение данных тайла для пользовательского слоя данных TileSet с именем layer_name.
| Имя | Тип | По умолчанию |
|---|---|---|
layerName | string | — |
value | Variant | — |
SetCustomDataByLayerIdvoid
public void SetCustomDataByLayerId(int layerId, Variant value);Устанавливает пользовательское значение данных тайла для пользовательского слоя данных TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
value | Variant | — |
SetFlipHvoid
public void SetFlipH(bool flipH);| Имя | Тип | По умолчанию |
|---|---|---|
flipH | bool | — |
SetFlipVvoid
public void SetFlipV(bool flipV);| Имя | Тип | По умолчанию |
|---|---|---|
flipV | bool | — |
SetMaterialvoid
public void SetMaterial(Material material);| Имя | Тип | По умолчанию |
|---|---|---|
material | Material | — |
SetModulatevoid
public void SetModulate(Color modulate);| Имя | Тип | По умолчанию |
|---|---|---|
modulate | Color | — |
SetNavigationPolygonvoid
public void SetNavigationPolygon(int layerId, NavigationPolygon navigationPolygon);Устанавливает навигационный полигон для навигационного слоя TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
navigationPolygon | NavigationPolygon | — |
SetOccludervoid · Устарело
public void SetOccluder(int layerId, OccluderPolygon2D occluderPolygon);Устанавливает окклюдер для слоя окклюзии TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
occluderPolygon | OccluderPolygon2D | — |
SetOccluderPolygonvoid
public void SetOccluderPolygon(int layerId, int polygonIndex, OccluderPolygon2D polygon);Устанавливает окклюдер для полигона с индексом polygon_index в слое окклюзии TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonIndex | int | — |
polygon | OccluderPolygon2D | — |
SetOccluderPolygonsCountvoid
public void SetOccluderPolygonsCount(int layerId, int polygonsCount);Устанавливает количество полигонов окклюдера в слое окклюзии TileSet с индексом layer_id.
| Имя | Тип | По умолчанию |
|---|---|---|
layerId | int | — |
polygonsCount | int | — |
SetProbabilityvoid
public void SetProbability(float probability);| Имя | Тип | По умолчанию |
|---|---|---|
probability | float | — |
SetTerrainvoid
public void SetTerrain(int terrain);| Имя | Тип | По умолчанию |
|---|---|---|
terrain | int | — |
SetTerrainPeeringBitvoid
public void SetTerrainPeeringBit(TileSet.CellNeighbor peeringBit, int terrain);Устанавливает бит ландшафта тайла для заданного направления peering_bit. Для проверки корректности направления используйте TileData.IsValidTerrainPeeringBit.
| Имя | Тип | По умолчанию |
|---|---|---|
peeringBit | TileSet.CellNeighbor | — |
terrain | int | — |
SetTerrainSetvoid
public void SetTerrainSet(int terrainSet);| Имя | Тип | По умолчанию |
|---|---|---|
terrainSet | int | — |
SetTextureOriginvoid
public void SetTextureOrigin(Vector2I textureOrigin);| Имя | Тип | По умолчанию |
|---|---|---|
textureOrigin | Vector2I | — |
SetTransposevoid
public void SetTranspose(bool transpose);| Имя | Тип | По умолчанию |
|---|---|---|
transpose | bool | — |
SetYSortOriginvoid
public void SetYSortOrigin(int ySortOrigin);| Имя | Тип | По умолчанию |
|---|---|---|
ySortOrigin | int | — |
SetZIndexvoid
public void SetZIndex(int zIndex);| Имя | Тип | По умолчанию |
|---|---|---|
zIndex | int | — |
Сигналы и события1
ChangedСобытие
public event Action Changed;Выдается при изменении любого из свойств.