paper kit
149 tools. Generated from the plugin source; do not edit by hand.
Guide
Use the paper kit for Paper2D-native assets and components. Enable the Paper2D engine plugin
first, then activate the paper kit if the server uses Adaptive exposure.
Start by creating a sprite, tile set, tile map, or flipbook under a /Game/... folder. Assign a
texture to a sprite or tile set with paper.sprite_set_source_texture or
paper.tile_set_set_sheet. For sprites, define the source region, pixels-per-unit and pivot, then
generate render/collision geometry from a bounding box or contours and rebuild it. Add sockets
only after the sprite geometry and pivot are stable.
For a flipbook, use paper.flipbook_add_keyframe or paper.flipbook_insert_keyframe, inspect
the resulting timeline with paper.flipbook_list_keyframes, set its frame rate and collision
source, then use paper.flipbook_audit_frames before assigning it to a component.
For a tile map, create or select a tile set, choose tile size and projection, add named layers,
then write cells with paper.tile_map_set_cell. Set layer visibility/collision separately and run
paper.tile_map_rebuild_collision after a batch of edits. tileIndex: -1 clears a cell. A packed
transform flag is passed only when you already know the Paper2D flag bits.
To place content in a level, create a PaperSprite, PaperFlipbook, or PaperTileMap component with
the component_add_* calls. A tile-map component referencing an asset must be made editable before
component-local map changes. Playback controls require PIE; asset defaults belong on the flipbook,
not the component.
An HD2D scene is a cross-kit recipe:
- Build characters and foreground elements as PaperSprites or flipbooks at one declared pixels-per-unit value.
- Use a PaperTileMap for collision/layout and separate background, middle and foreground layers.
- Create a camera through
camera.*: choose orthographic for exact pixel framing, or perspective with a long focal length and modest depth separation for the miniature look. - Keep TileMap
separationPerLayersmall and intentional; use actor/component depth for large parallax planes. - Create parallax planes and camera movement with
level.*,actor.*, andsequencer.*; do not encode camera parallax in sprite source regions. - Use Paper2D materials from
material.*; preserve a shared material convention for texture, vertex color, normal/emissive use, and translucent/masked blending. - Add restrained key and fill lights with
lighting.*, then inspect sprite/tile material assignment with the paper inspection calls. - Audit flipbook frames, tile collision, and component render statistics before playtesting.
paper intentionally does not import image files, edit generic material graphs, spawn non-Paper2D
actors, manage camera projection, or pack sprite atlases. Those operations have existing owners.
All asset paths are Unreal object paths; folders must begin with /Game/. Materials and textures
referenced by a Paper2D asset must already exist. Geometry contour extraction depends on source
texture data, so an empty sprite can be valid but cannot produce useful contours.
Components by label
paper.spawn_actor {"label":"Hero","kind":"sprite|flipbook|tile_map","source":"<asset>"} places a Paper2D actor in the editor level (paper.pie_spawn_actor does the same in a running PIE session) and paper.remove_actor deletes one. Every component argument accepts <actorLabel>.<componentName> instead of a world-dependent object path: a spawned actor's component is Hero.RenderComponent, components added with paper.component_add_* use the name you gave. Flipbook playback tools (component_play_flipbook, component_stop_flipbook, looping, play rate) need a PIE component.
Engine content that works everywhere: texture /Engine/EngineResources/DefaultTexture (sprite source, tile sheet) and material /Engine/EngineMaterials/DefaultMaterial. Tile-index tools need a tile set with a sheet: pass texture and a small tileWidth/tileHeight to paper.create_tile_set.
Tools
Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above
MaxAutoRiskneed"_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours thedryRunargument. smoke = covered byedit.self_test.
paper.audit_asset (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.batch_audit_folder (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.batch_find_flipbook_frame_gaps (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.batch_find_missing_textures (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.batch_find_sprite_material_gaps (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.batch_find_tile_map_collision_gaps (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.batch_rebuild_sprites (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.component_add_flipbook (risk 2, mutates, requires plugin Paper2D, requires world, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
actor | string | required. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Returns: item, notes.
paper.component_add_sprite (risk 2, mutates, requires plugin Paper2D, requires world, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
actor | string | required. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Returns: item, notes.
paper.component_add_tile_map (risk 2, mutates, requires plugin Paper2D, requires world, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
actor | string | required. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Returns: item, notes.
paper.component_create_owned_tile_map (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.component_get_flipbook (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.component_get_materials (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.component_get_sprite (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.component_get_tile_map (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.component_get_tile_rendering_stats (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.component_list (risk 0, requires plugin Paper2D, requires world, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
actor | string | required. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Returns: values, items, count.
paper.component_make_tile_map_editable (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.component_play_flipbook (risk 1, mutates, requires plugin Paper2D, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.component_rebuild_tile_collision (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.component_resize_tile_map (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.component_set_flipbook (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Flipbook, tile map, component object path, or |
source | string | required. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Default 0. |
run | integer | Frame run length, at least one. Default 1. |
Returns: item, notes.
paper.component_set_flipbook_looping (risk 1, mutates, requires plugin Paper2D, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.component_set_flipbook_play_rate (risk 1, mutates, requires plugin Paper2D, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.component_set_material (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Sprite, flipbook, tile-map, Paper2D component object path, or |
material | string | Material interface object path; an empty value clears a material where supported. |
slot | integer | Material slot, normally zero. Default 0. |
Returns: item, notes.
paper.component_set_sprite (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Flipbook, tile map, component object path, or |
source | string | required. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Default 0. |
run | integer | Frame run length, at least one. Default 1. |
Returns: item, notes.
paper.component_set_sprite_color (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Default 1.0f. |
g | number | Green channel, 0 through 1. Default 1.0f. |
b | number | Blue channel, 0 through 1. Default 1.0f. |
a | number | Alpha channel, 0 through 1. Default 1.0f. |
layer | integer | Optional layer index. Default 0. |
Returns: item, notes.
paper.component_set_tile_layer_collision (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.component_set_tile_layer_color (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Default 1.0f. |
g | number | Green channel, 0 through 1. Default 1.0f. |
b | number | Blue channel, 0 through 1. Default 1.0f. |
a | number | Alpha channel, 0 through 1. Default 1.0f. |
layer | integer | Optional layer index. Default 0. |
Returns: item, notes.
paper.component_set_tile_map (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Flipbook, tile map, component object path, or |
source | string | required. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Default 0. |
run | integer | Frame run length, at least one. Default 1. |
Returns: item, notes.
paper.component_set_tile_map_color (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Default 1.0f. |
g | number | Green channel, 0 through 1. Default 1.0f. |
b | number | Blue channel, 0 through 1. Default 1.0f. |
a | number | Alpha channel, 0 through 1. Default 1.0f. |
layer | integer | Optional layer index. Default 0. |
Returns: item, notes.
paper.component_stop_flipbook (risk 1, mutates, requires plugin Paper2D, requires PIE, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.create_flipbook (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | required. Destination content folder. |
name | string | required. Bare name for the new asset. |
texture | string | Optional texture asset used to initialize sprite or tile-set assets. |
width | integer | Optional width in tiles for a new tile map. Default 4. |
height | integer | Optional height in tiles for a new tile map. Default 4. |
tileWidth | integer | Tile width in source pixels. Default 32. |
tileHeight | integer | Tile height in source pixels. Default 32. |
pixelsPerUnit | number | Pixels represented by one Unreal unit. Default 1.0f. |
Returns: item, notes.
paper.create_sprite (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | required. Destination content folder. |
name | string | required. Bare name for the new asset. |
texture | string | Optional texture asset used to initialize sprite or tile-set assets. |
width | integer | Optional width in tiles for a new tile map. Default 4. |
height | integer | Optional height in tiles for a new tile map. Default 4. |
tileWidth | integer | Tile width in source pixels. Default 32. |
tileHeight | integer | Tile height in source pixels. Default 32. |
pixelsPerUnit | number | Pixels represented by one Unreal unit. Default 1.0f. |
Returns: item, notes.
paper.create_tile_map (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | required. Destination content folder. |
name | string | required. Bare name for the new asset. |
texture | string | Optional texture asset used to initialize sprite or tile-set assets. |
width | integer | Optional width in tiles for a new tile map. Default 4. |
height | integer | Optional height in tiles for a new tile map. Default 4. |
tileWidth | integer | Tile width in source pixels. Default 32. |
tileHeight | integer | Tile height in source pixels. Default 32. |
pixelsPerUnit | number | Pixels represented by one Unreal unit. Default 1.0f. |
Returns: item, notes.
paper.create_tile_set (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | required. Destination content folder. |
name | string | required. Bare name for the new asset. |
texture | string | Optional texture asset used to initialize sprite or tile-set assets. |
width | integer | Optional width in tiles for a new tile map. Default 4. |
height | integer | Optional height in tiles for a new tile map. Default 4. |
tileWidth | integer | Tile width in source pixels. Default 32. |
tileHeight | integer | Tile height in source pixels. Default 32. |
pixelsPerUnit | number | Pixels represented by one Unreal unit. Default 1.0f. |
Returns: item, notes.
paper.flipbook_add_keyframe (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Flipbook, tile map, component object path, or |
source | string | required. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Default 0. |
run | integer | Frame run length, at least one. Default 1. |
Returns: item, notes.
paper.flipbook_audit_frames (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.flipbook_clear_default_material (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.flipbook_clear_keyframes (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.flipbook_duplicate_keyframe (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.flipbook_get (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.flipbook_get_collision_source (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.flipbook_get_frame_sprite (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.flipbook_get_material (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.flipbook_get_sprite_at_time (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.flipbook_get_timing (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.flipbook_insert_keyframe (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Flipbook, tile map, component object path, or |
source | string | required. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Default 0. |
run | integer | Frame run length, at least one. Default 1. |
Returns: item, notes.
paper.flipbook_list_keyframes (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.flipbook_list_sockets (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.flipbook_move_keyframe (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.flipbook_remove_keyframe (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.flipbook_reverse_keyframes (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.flipbook_set_collision_source (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.flipbook_set_default_material (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Sprite, flipbook, tile-map, Paper2D component object path, or |
material | string | Material interface object path; an empty value clears a material where supported. |
slot | integer | Material slot, normally zero. Default 0. |
Returns: item, notes.
paper.flipbook_set_frames_per_second (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.flipbook_set_keyframe_run (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Flipbook, tile map, component object path, or |
source | string | required. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Default 0. |
run | integer | Frame run length, at least one. Default 1. |
Returns: item, notes.
paper.flipbook_set_keyframe_sprite (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Flipbook, tile map, component object path, or |
source | string | required. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Default 0. |
run | integer | Frame run length, at least one. Default 1. |
Returns: item, notes.
paper.get_asset (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.get_asset_bounds (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.list_asset_materials (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.list_asset_textures (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.list_flipbooks (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.list_sprites (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.list_tile_maps (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.list_tile_sets (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.
paper.pie_spawn_actor (risk 1, mutates, requires plugin Paper2D, requires PIE, smoke)
Spawns a Paper2D actor in the running PIE session (for playback checks); its component is
| Argument | Type | Description |
|---|---|---|
label | string | required. Actor label for the new actor; its component is addressed as |
kind | string | Actor kind: sprite, flipbook, or tile_map. Default TEXT("sprite"). |
source | string | Optional PaperSprite, PaperFlipbook, or PaperTileMap asset matching the kind. |
location | {x,y,z} | World location in centimetres. |
Returns: item, notes.
paper.rebuild_asset (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.remove_actor (risk 3, mutates, destructive, requires plugin Paper2D, requires world, smoke)
Deletes an actor that owns Paper2D components from the editor world (PIE actors are destroyed in PIE).
| Argument | Type | Description |
|---|---|---|
actor | string | required. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Returns: item, notes.
paper.spawn_actor (risk 2, mutates, requires plugin Paper2D, requires world, smoke)
Spawns a PaperSpriteActor, PaperFlipbookActor, or PaperTileMapActor in the editor world, optionally assigning its asset; its component is
| Argument | Type | Description |
|---|---|---|
label | string | required. Actor label for the new actor; its component is addressed as |
kind | string | Actor kind: sprite, flipbook, or tile_map. Default TEXT("sprite"). |
source | string | Optional PaperSprite, PaperFlipbook, or PaperTileMap asset matching the kind. |
location | {x,y,z} | World location in centimetres. |
Returns: item, notes.
paper.sprite_add_socket (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
name | string | required. Name, socket name, or layer label. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.sprite_clear_alternate_material (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.sprite_create_collision_box (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.sprite_create_collision_contours (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.sprite_create_render_box (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.sprite_create_render_contours (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.sprite_extract_region (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.sprite_find_alpha_bounds (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.sprite_get (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.sprite_get_baked_data (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.sprite_get_collision_geometry (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.sprite_get_pivot (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.sprite_get_pixels_per_unit (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.sprite_get_render_geometry (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.sprite_list_sockets (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.sprite_rebuild_collision (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.sprite_rebuild_render_data (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.sprite_remove_socket (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
name | string | required. Name, socket name, or layer label. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.sprite_rename_socket (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
oldName | string | required. Existing name. |
newName | string | required. Replacement name. |
Returns: item, notes.
paper.sprite_set_alternate_material (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Sprite, flipbook, tile-map, Paper2D component object path, or |
material | string | Material interface object path; an empty value clears a material where supported. |
slot | integer | Material slot, normally zero. Default 0. |
Returns: item, notes.
paper.sprite_set_collision_domain (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.sprite_set_collision_thickness (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.sprite_set_custom_pivot (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.sprite_set_default_material (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Sprite, flipbook, tile-map, Paper2D component object path, or |
material | string | Material interface object path; an empty value clears a material where supported. |
slot | integer | Material slot, normally zero. Default 0. |
Returns: item, notes.
paper.sprite_set_pivot_mode (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.sprite_set_pixels_per_unit (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.sprite_set_rotated (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.sprite_set_snap_pivot (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.sprite_set_socket_transform (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Sprite asset object path. |
name | string | required. Socket name. |
location | {x,y,z} | Location in sprite local centimetres. |
rotation | {x,y,z} | Rotation in degrees. |
scale | {x,y,z} | Scale multiplier. Default FUeaVec3(1,1,1). |
Returns: item, notes.
paper.sprite_set_source_region (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.sprite_set_source_texture (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Sprite or tile-set asset object path. |
texture | string | required. Texture2D asset object path. |
Returns: item, notes.
paper.sprite_set_trim (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.sprite_validate_sockets (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.tile_map_add_layer (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
name | string | required. Name, socket name, or layer label. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.tile_map_clear_cell (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. PaperTileMap asset or PaperTileMapComponent object path. |
tileSet | string | PaperTileSet asset object path. Empty clears the cell. |
tileIndex | integer | Tile index in the tile set; use -1 to clear. Default -1. |
x | integer | Cell X coordinate. Default 0. |
y | integer | Cell Y coordinate. Default 0. |
layer | integer | Tile-layer index. Default 0. |
transformFlags | integer | Packed transform flag bits supplied by Paper2D. Default 0. |
Returns: item, notes.
paper.tile_map_clear_material (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.tile_map_get (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.tile_map_get_cell (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. PaperTileMap asset or PaperTileMapComponent object path. |
tileSet | string | PaperTileSet asset object path. Empty clears the cell. |
tileIndex | integer | Tile index in the tile set; use -1 to clear. Default -1. |
x | integer | Cell X coordinate. Default 0. |
y | integer | Cell Y coordinate. Default 0. |
layer | integer | Tile-layer index. Default 0. |
transformFlags | integer | Packed transform flag bits supplied by Paper2D. Default 0. |
Returns: values, items, count.
paper.tile_map_get_cell_polygon (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: values, items, count.
paper.tile_map_get_cell_position (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: values, items, count.
paper.tile_map_list_layers (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.tile_map_rebuild_collision (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.tile_map_remove_layer (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.tile_map_rename_layer (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
name | string | required. Name, socket name, or layer label. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.tile_map_resize (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.tile_map_set_cell (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. PaperTileMap asset or PaperTileMapComponent object path. |
tileSet | string | PaperTileSet asset object path. Empty clears the cell. |
tileIndex | integer | Tile index in the tile set; use -1 to clear. Default -1. |
x | integer | Cell X coordinate. Default 0. |
y | integer | Cell Y coordinate. Default 0. |
layer | integer | Tile-layer index. Default 0. |
transformFlags | integer | Packed transform flag bits supplied by Paper2D. Default 0. |
Returns: item, notes.
paper.tile_map_set_collision_domain (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.tile_map_set_collision_thickness (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.tile_map_set_hex_side_length (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.tile_map_set_layer_collision (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.tile_map_set_layer_color (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Default 1.0f. |
g | number | Green channel, 0 through 1. Default 1.0f. |
b | number | Blue channel, 0 through 1. Default 1.0f. |
a | number | Alpha channel, 0 through 1. Default 1.0f. |
layer | integer | Optional layer index. Default 0. |
Returns: item, notes.
paper.tile_map_set_layer_hidden_editor (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.tile_map_set_layer_hidden_game (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Default false. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.tile_map_set_layer_separation (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.tile_map_set_material (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Sprite, flipbook, tile-map, Paper2D component object path, or |
material | string | Material interface object path; an empty value clears a material where supported. |
slot | integer | Material slot, normally zero. Default 0. |
Returns: item, notes.
paper.tile_map_set_pixels_per_unit (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.tile_map_set_projection (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.tile_map_set_tile_separation_x (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.tile_map_set_tile_separation_y (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Default 0.0f. |
index | integer | Optional secondary index. Default 0. |
Returns: item, notes.
paper.tile_map_set_tile_size (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.tile_set_add_terrain (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
name | string | required. Name, socket name, or layer label. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.tile_set_clear_tile_collision (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.tile_set_clear_tile_user_data (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: item, notes.
paper.tile_set_find_tile_from_uv (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: values, items, count.
paper.tile_set_get (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: item, notes.
paper.tile_set_get_grid (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.tile_set_get_tile (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: values, items, count.
paper.tile_set_get_tile_collision (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: values, items, count.
paper.tile_set_get_tile_uv (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: values, items, count.
paper.tile_set_get_tile_xy (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Default 0. |
index | integer | Optional secondary integer such as layer index. Default 0. |
Returns: values, items, count.
paper.tile_set_list_terrain (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Paper2D asset object path, component object path, or |
Returns: values, items, count.
paper.tile_set_set_background_color (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Default 1.0f. |
g | number | Green channel, 0 through 1. Default 1.0f. |
b | number | Blue channel, 0 through 1. Default 1.0f. |
a | number | Alpha channel, 0 through 1. Default 1.0f. |
layer | integer | Optional layer index. Default 0. |
Returns: item, notes.
paper.tile_set_set_border_margin (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.tile_set_set_drawing_offset (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.tile_set_set_sheet (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Sprite or tile-set asset object path. |
texture | string | required. Texture2D asset object path. |
Returns: item, notes.
paper.tile_set_set_spacing (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.tile_set_set_tile_size (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Default 0. |
y | integer | Y coordinate in pixels or tile cells. Default 0. |
layer | integer | Optional layer index. Default 0. |
width | integer | Optional width in pixels or cells. Default 0. |
height | integer | Optional height in pixels or cells. Default 0. |
Returns: item, notes.
paper.tile_set_set_tile_user_data (risk 2, mutates, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | required. Target Paper2D asset, component object path, or |
name | string | required. Name, socket name, or layer label. |
index | integer | Optional target index. Default 0. |
Returns: item, notes.
paper.validate_folder (risk 0, requires plugin Paper2D, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Default 100. |
Returns: items, count.