Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

Sprite

Windows

MacOS

Linux

On this page

Actions

Actions

Add New Layer	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 Target is Paper Tile Map Component
Break Tile	Breaks out the information for a tile Target is Tile Map Blueprint Library
Create New Tile Map	Creates a new tile map of the specified size, replacing the TileMap reference (or dropping the previous owned one) Target is Paper Tile Map Component
Get Flipbook	Gets the flipbook used by this instance. Target is Paper Flipbook Component
Get Key Frame Index at Time	Returns the keyframe index that covers the specified time (in seconds), or INDEX_NONE if none exists. When bClampToEnds is true, it will choose the first or last keyframe if the time is out of range. Target is Paper Flipbook
Get Layer Color	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) Target is Paper Tile Map Component
Get Map Size	Returns the size of the tile map Target is Paper Tile Map Component
Get Num Frames	Returns the total number of frames Target is Paper Flipbook
Get Num Key Frames	Returns the number of key frames Target is Paper Flipbook
Get Sprite	Gets the PaperSprite used by this instance. Target is Paper Sprite Component
Get Sprite at Frame	Returns the sprite at the specified keyframe index, or nullptr if none exists Target is Paper Flipbook
Get Sprite at Time	Returns the sprite at the specified time (in seconds), or nullptr if none exists. When bClampToEnds is true, it will choose the first or last sprite if the time is out of range. Target is Paper Flipbook
Get Tile	Returns the contents of a specified tile cell Target is Paper Tile Map Component
Get Tile Center Position	Returns the position of the center of the specified tile Target is Paper Tile Map Component
Get Tile Corner Position	Returns the position of the top left corner of the specified tile Target is Paper Tile Map Component
Get Tile Map Color	Gets the tile map global color multiplier (multiplied with the per-layer color and passed to the material as a vertex color) Target is Paper Tile Map Component
Get Tile Polygon	Returns the polygon for the specified tile (will be 4 or 6 vertices as a rectangle, diamond, or hexagon) Target is Paper Tile Map Component
Get Tile Transform	Returns the transform for a tile Target is Tile Map Blueprint Library
Get Tile User Data	Returns the user data name for the specified tile, or NAME_None if there is no user-specified data Target is Tile Map Blueprint Library
Get Total Duration	Returns the total duration in seconds Target is Paper Flipbook
Is Valid Key Frame Index	Is the specified Index within the valid range of key frames? Target is Paper Flipbook
Make Tile	Creates a tile from the specified information Target is Tile Map Blueprint Library
Make Tile Map Editable	Makes the tile map asset pointed to by this component editable. Nothing happens if it was already instanced, but if the tile map is an asset reference, it is cloned to make a unique instance. Target is Paper Tile Map Component
Owns Tile Map	Does this component own the tile map (is it instanced instead of being an asset reference)? Target is Paper Tile Map Component
Rebuild Collision	Rebuilds collision for the tile map Target is Paper Tile Map Component
Resize Map	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) Target is Paper Tile Map Component
Set Default Collision Thickness	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 Target is Paper Tile Map Component
Set Flipbook	Change the flipbook used by this instance (will reset the play time to 0 if it is a new flipbook). Target is Paper Flipbook Component
Set Layer Collision	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 Target is Paper Tile Map Component
Set Layer Color	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 Target is Paper Tile Map Component
Set Sprite	Change the PaperSprite used by this instance. Target is Paper Sprite Component
Set Sprite Color	Set color of the sprite Target is Paper Sprite Component
Set Terrain Color	Set color of the terrain Target is Paper Terrain Component
Set Tile	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 Target is Paper Tile Map Component
Set Tile Map	Change the PaperTileMap used by this instance. Target is Paper Tile Map Component
Set Tile Map Color	Sets the tile map global color multiplier (multiplied with the per-layer color and passed to the material as a vertex color) Target is Paper Tile Map Component

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss