| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperTileMapComponent.h |
Include |
#include "PaperTileMapComponent.h" |
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=Object, ClassGroup=Paper2D, EarlyAccessPreview,
Meta=(BlueprintSpawnableComponent))
class PAPER2UPaperTileMapComponent : public UMeshComponent
A component that handles rendering and collision for a single instance of a UPaperTileMap asset.
This component is created when you drag a tile map asset from the content browser into a Blueprint, or contained inside of the actor created when you drag one into the level.
NOTE: This is an beta preview class. While not considered production-ready, it is a step beyond 'experimental' and is being provided as a preview of things to come:
We will try to provide forward-compatibility for content you create.
The classes may change significantly in the future.
The code is in an early state and may not meet the desired polish / quality bar.
There is probably no documentation or example content yet.
They will be promoted out of 'beta' when they are production ready.
Name | Description | ||
---|---|---|---|
|
bShowOutlineWhenUnselected |
Should this component show an outline around the first layer when the component is not selected? |
|
|
bShowPerLayerGridWhenSelected |
Should this component show an outline around each layer when the component is selected? |
|
|
bShowPerLayerGridWhenUnselected |
Should this component show an outline around each layer when the component is not selected? |
|
|
bShowPerTileGridWhenSelected |
Should this component show a tile grid when the component is selected? |
|
|
bShowPerTileGridWhenUnselected |
Should this component show a tile grid when the component is not selected? |
|
|
friend |
FPaperTileMapRenderSceneProxy |
|
|
UPaperTileMap &... |
TileMap |
The tile map used by this component. |
Name | Description | |
---|---|---|
|
PAPER2UPaperTileMapComponent ( |
Name | Description | ||
---|---|---|---|
|
UPaperTileLa... |
AddNewLayer() |
Creates and adds a new layer to the tile map Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets |
|
CreateNewOwnedTileMap() |
Creates a new tile map internally, replacing the TileMap reference (or dropping the previous owned one) |
|
|
CreateNewTileMap |
Creates a new tile map of the specified size, replacing the TileMap reference (or dropping the previous owned one) |
|
|
GetLayerColor ( |
Gets the per-layer color multiplier for a specific layer (multiplied with the tile map color and passed to the material as a vertex color) |
|
|
GetMapSize |
Returns the size of the tile map. |
|
|
GetRenderingStats |
Returns the rendering stats for this component. |
|
|
FPaperTileIn... |
GetTile |
Returns the contents of a specified tile cell. |
|
GetTileCenterPosition |
Returns the position of the center of the specified tile. |
|
|
GetTileCornerPosition |
Returns the position of the top left corner of the specified tile. |
|
|
GetTileMapColor() |
Gets the tile map global color multiplier (multiplied with the per-layer color and passed to the material as a vertex color) |
|
|
GetTilePolygon |
Returns the polygon for the specified tile (will be 4 or 6 vertices as a rectangle, diamond, or hexagon) |
|
|
GetWireframeColor() |
Returns the wireframe color to use for this component. |
|
|
MakeTileMapEditable() |
Makes the tile map asset pointed to by this component editable. |
|
|
OwnsTileMap() |
Does this component own the tile map (is it instanced instead of being an asset reference)? |
|
|
RebuildCollision() |
Rebuilds collision for the tile map. |
|
|
RebuildRenderData ( |
||
|
ResizeMap |
Resizes the tile map (Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets) |
|
|
SetDefaultCollisionThickness ( |
Sets the default thickness for any layers that don't override the collision thickness Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets |
|
|
SetLayerCollision |
Sets the collision thickness for a specific layer Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets |
|
|
SetLayerColor ( |
Sets the per-layer color multiplier for a specific layer (multiplied with the tile map color and passed to the material as a vertex color) Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets |
|
|
SetTile ( |
Modifies the contents of a specified tile cell (Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets) Note: Does not update collision by default, call RebuildCollision after all edits have been done in a frame if necessary |
|
|
SetTileMap ( |
Change the PaperTileMap used by this instance. |
|
|
SetTileMapColor ( |
Sets the tile map global color multiplier (multiplied with the per-layer color and passed to the material as a vertex color) |
Name | Description | ||
---|---|---|---|
|
FPrimitiveSc... |
CreateSceneProxy() |
Creates a proxy to represent the primitive to the scene manager in the rendering thread. |
|
UBodySetup &... |
GetBodySetup() |
Return the BodySetup to use for this PrimitiveComponent (single body case) |
|
UMaterialInt... |
GetMaterial ( |
Returns the material used by the element at the specified index |
|
GetNumMaterials() |
Return number of material elements in this primitive |
|
|
GetUsedTextures ( |
Returns the material textures used to render this primitive for the given platform. |
Name | Description | ||
---|---|---|---|
|
FBoxSphereBo... |
CalcBounds ( |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. |
Name | Description | ||
---|---|---|---|
|
const UObjec... |
AdditionalStatObject() |
Give a readable name for this component, including asset name if applicable |
Name | Description | ||
---|---|---|---|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
UPaperTileMap