Kit paper
149 herramientas. Generado a partir del código fuente del plugin; no lo edites a mano.
Las descripciones de las herramientas y de los argumentos se muestran en inglés porque reflejan el schema de las herramientas (el mismo texto que el agente recibe en
tools/list).
Guía
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.
Herramientas
Leyenda. riesgo 0 = solo lectura, 1 = operación inofensiva del editor, 2 = modifica un asset, 3 = elimina/reemplaza un asset, 4 = proyecto/configuración/build, 5 = potencialmente destructivo (las llamadas por encima de
MaxAutoRiskrequieren"_confirm": true). modifica = se ejecuta en una transacción (edit.undo la revierte). requiere PIE / requiere mundo = se rechaza sin una sesión PIE / sin un nivel abierto. requiere el plugin = no disponible cuando el plugin está desactivado. dryRun = acepta el argumentodryRun. smoke = cubierto poredit.self_test.
paper.audit_asset (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.batch_audit_folder (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.batch_find_flipbook_frame_gaps (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.batch_find_missing_textures (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.batch_find_sprite_material_gaps (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.batch_find_tile_map_collision_gaps (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.batch_rebuild_sprites (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.component_add_flipbook (riesgo 2, modifica, requiere el plugin Paper2D, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Devuelve: item, notes.
paper.component_add_sprite (riesgo 2, modifica, requiere el plugin Paper2D, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Devuelve: item, notes.
paper.component_add_tile_map (riesgo 2, modifica, requiere el plugin Paper2D, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Devuelve: item, notes.
paper.component_create_owned_tile_map (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.component_get_flipbook (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.component_get_materials (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.component_get_sprite (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.component_get_tile_map (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.component_get_tile_rendering_stats (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.component_list (riesgo 0, requiere el plugin Paper2D, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Devuelve: values, items, count.
paper.component_make_tile_map_editable (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.component_play_flipbook (riesgo 1, modifica, requiere el plugin Paper2D, requiere PIE, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.component_rebuild_tile_collision (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.component_resize_tile_map (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.component_set_flipbook (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Flipbook, tile map, component object path, or |
source | string | obligatorio. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Valor predeterminado 0. |
run | integer | Frame run length, at least one. Valor predeterminado 1. |
Devuelve: item, notes.
paper.component_set_flipbook_looping (riesgo 1, modifica, requiere el plugin Paper2D, requiere PIE, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.component_set_flipbook_play_rate (riesgo 1, modifica, requiere el plugin Paper2D, requiere PIE, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.component_set_material (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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. Valor predeterminado 0. |
Devuelve: item, notes.
paper.component_set_sprite (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Flipbook, tile map, component object path, or |
source | string | obligatorio. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Valor predeterminado 0. |
run | integer | Frame run length, at least one. Valor predeterminado 1. |
Devuelve: item, notes.
paper.component_set_sprite_color (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Valor predeterminado 1.0f. |
g | number | Green channel, 0 through 1. Valor predeterminado 1.0f. |
b | number | Blue channel, 0 through 1. Valor predeterminado 1.0f. |
a | number | Alpha channel, 0 through 1. Valor predeterminado 1.0f. |
layer | integer | Optional layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.component_set_tile_layer_collision (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.component_set_tile_layer_color (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Valor predeterminado 1.0f. |
g | number | Green channel, 0 through 1. Valor predeterminado 1.0f. |
b | number | Blue channel, 0 through 1. Valor predeterminado 1.0f. |
a | number | Alpha channel, 0 through 1. Valor predeterminado 1.0f. |
layer | integer | Optional layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.component_set_tile_map (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Flipbook, tile map, component object path, or |
source | string | obligatorio. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Valor predeterminado 0. |
run | integer | Frame run length, at least one. Valor predeterminado 1. |
Devuelve: item, notes.
paper.component_set_tile_map_color (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Valor predeterminado 1.0f. |
g | number | Green channel, 0 through 1. Valor predeterminado 1.0f. |
b | number | Blue channel, 0 through 1. Valor predeterminado 1.0f. |
a | number | Alpha channel, 0 through 1. Valor predeterminado 1.0f. |
layer | integer | Optional layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.component_stop_flipbook (riesgo 1, modifica, requiere el plugin Paper2D, requiere PIE, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.create_flipbook (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. 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. Valor predeterminado 4. |
height | integer | Optional height in tiles for a new tile map. Valor predeterminado 4. |
tileWidth | integer | Tile width in source pixels. Valor predeterminado 32. |
tileHeight | integer | Tile height in source pixels. Valor predeterminado 32. |
pixelsPerUnit | number | Pixels represented by one Unreal unit. Valor predeterminado 1.0f. |
Devuelve: item, notes.
paper.create_sprite (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. 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. Valor predeterminado 4. |
height | integer | Optional height in tiles for a new tile map. Valor predeterminado 4. |
tileWidth | integer | Tile width in source pixels. Valor predeterminado 32. |
tileHeight | integer | Tile height in source pixels. Valor predeterminado 32. |
pixelsPerUnit | number | Pixels represented by one Unreal unit. Valor predeterminado 1.0f. |
Devuelve: item, notes.
paper.create_tile_map (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. 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. Valor predeterminado 4. |
height | integer | Optional height in tiles for a new tile map. Valor predeterminado 4. |
tileWidth | integer | Tile width in source pixels. Valor predeterminado 32. |
tileHeight | integer | Tile height in source pixels. Valor predeterminado 32. |
pixelsPerUnit | number | Pixels represented by one Unreal unit. Valor predeterminado 1.0f. |
Devuelve: item, notes.
paper.create_tile_set (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. 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. Valor predeterminado 4. |
height | integer | Optional height in tiles for a new tile map. Valor predeterminado 4. |
tileWidth | integer | Tile width in source pixels. Valor predeterminado 32. |
tileHeight | integer | Tile height in source pixels. Valor predeterminado 32. |
pixelsPerUnit | number | Pixels represented by one Unreal unit. Valor predeterminado 1.0f. |
Devuelve: item, notes.
paper.flipbook_add_keyframe (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Flipbook, tile map, component object path, or |
source | string | obligatorio. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Valor predeterminado 0. |
run | integer | Frame run length, at least one. Valor predeterminado 1. |
Devuelve: item, notes.
paper.flipbook_audit_frames (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.flipbook_clear_default_material (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.flipbook_clear_keyframes (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.flipbook_duplicate_keyframe (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.flipbook_get (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.flipbook_get_collision_source (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.flipbook_get_frame_sprite (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.flipbook_get_material (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.flipbook_get_sprite_at_time (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.flipbook_get_timing (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.flipbook_insert_keyframe (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Flipbook, tile map, component object path, or |
source | string | obligatorio. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Valor predeterminado 0. |
run | integer | Frame run length, at least one. Valor predeterminado 1. |
Devuelve: item, notes.
paper.flipbook_list_keyframes (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.flipbook_list_sockets (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.flipbook_move_keyframe (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.flipbook_remove_keyframe (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.flipbook_reverse_keyframes (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.flipbook_set_collision_source (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.flipbook_set_default_material (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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. Valor predeterminado 0. |
Devuelve: item, notes.
paper.flipbook_set_frames_per_second (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.flipbook_set_keyframe_run (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Flipbook, tile map, component object path, or |
source | string | obligatorio. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Valor predeterminado 0. |
run | integer | Frame run length, at least one. Valor predeterminado 1. |
Devuelve: item, notes.
paper.flipbook_set_keyframe_sprite (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Flipbook, tile map, component object path, or |
source | string | obligatorio. PaperSprite or PaperFlipbook object path. |
index | integer | Frame or layer index. Valor predeterminado 0. |
run | integer | Frame run length, at least one. Valor predeterminado 1. |
Devuelve: item, notes.
paper.get_asset (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.get_asset_bounds (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.list_asset_materials (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.list_asset_textures (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.list_flipbooks (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.list_sprites (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.list_tile_maps (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.list_tile_sets (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.
paper.pie_spawn_actor (riesgo 1, modifica, requiere el plugin Paper2D, requiere PIE, smoke)
Spawns a Paper2D actor in the running PIE session (for playback checks); its component is
| Argumento | Tipo | Descripción |
|---|---|---|
label | string | obligatorio. Actor label for the new actor; its component is addressed as |
kind | string | Actor kind: sprite, flipbook, or tile_map. Valor predeterminado TEXT("sprite"). |
source | string | Optional PaperSprite, PaperFlipbook, or PaperTileMap asset matching the kind. |
location | {x,y,z} | World location in centimetres. |
Devuelve: item, notes.
paper.rebuild_asset (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.remove_actor (riesgo 3, modifica, destructivo, requiere el plugin Paper2D, requiere mundo, smoke)
Deletes an actor that owns Paper2D components from the editor world (PIE actors are destroyed in PIE).
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label, actor name, or actor object path. |
name | string | Component name. |
source | string | Paper2D asset assigned to the created or existing component. |
Devuelve: item, notes.
paper.spawn_actor (riesgo 2, modifica, requiere el plugin Paper2D, requiere mundo, smoke)
Spawns a PaperSpriteActor, PaperFlipbookActor, or PaperTileMapActor in the editor world, optionally assigning its asset; its component is
| Argumento | Tipo | Descripción |
|---|---|---|
label | string | obligatorio. Actor label for the new actor; its component is addressed as |
kind | string | Actor kind: sprite, flipbook, or tile_map. Valor predeterminado TEXT("sprite"). |
source | string | Optional PaperSprite, PaperFlipbook, or PaperTileMap asset matching the kind. |
location | {x,y,z} | World location in centimetres. |
Devuelve: item, notes.
paper.sprite_add_socket (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
name | string | obligatorio. Name, socket name, or layer label. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_clear_alternate_material (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.sprite_create_collision_box (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_create_collision_contours (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.sprite_create_render_box (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_create_render_contours (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.sprite_extract_region (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_find_alpha_bounds (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_get (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.sprite_get_baked_data (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.sprite_get_collision_geometry (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.sprite_get_pivot (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.sprite_get_pixels_per_unit (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.sprite_get_render_geometry (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.sprite_list_sockets (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.sprite_rebuild_collision (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.sprite_rebuild_render_data (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.sprite_remove_socket (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
name | string | obligatorio. Name, socket name, or layer label. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_rename_socket (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
oldName | string | obligatorio. Existing name. |
newName | string | obligatorio. Replacement name. |
Devuelve: item, notes.
paper.sprite_set_alternate_material (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_collision_domain (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_collision_thickness (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_custom_pivot (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_default_material (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_pivot_mode (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_pixels_per_unit (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_rotated (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_snap_pivot (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_socket_transform (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Sprite asset object path. |
name | string | obligatorio. Socket name. |
location | {x,y,z} | Location in sprite local centimetres. |
rotation | {x,y,z} | Rotation in degrees. |
scale | {x,y,z} | Scale multiplier. Valor predeterminado FUeaVec3(1,1,1). |
Devuelve: item, notes.
paper.sprite_set_source_region (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_set_source_texture (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Sprite or tile-set asset object path. |
texture | string | obligatorio. Texture2D asset object path. |
Devuelve: item, notes.
paper.sprite_set_trim (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.sprite_validate_sockets (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.tile_map_add_layer (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
name | string | obligatorio. Name, socket name, or layer label. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_clear_cell (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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. Valor predeterminado -1. |
x | integer | Cell X coordinate. Valor predeterminado 0. |
y | integer | Cell Y coordinate. Valor predeterminado 0. |
layer | integer | Tile-layer index. Valor predeterminado 0. |
transformFlags | integer | Packed transform flag bits supplied by Paper2D. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_clear_material (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.tile_map_get (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.tile_map_get_cell (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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. Valor predeterminado -1. |
x | integer | Cell X coordinate. Valor predeterminado 0. |
y | integer | Cell Y coordinate. Valor predeterminado 0. |
layer | integer | Tile-layer index. Valor predeterminado 0. |
transformFlags | integer | Packed transform flag bits supplied by Paper2D. Valor predeterminado 0. |
Devuelve: values, items, count.
paper.tile_map_get_cell_polygon (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: values, items, count.
paper.tile_map_get_cell_position (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: values, items, count.
paper.tile_map_list_layers (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.tile_map_rebuild_collision (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.tile_map_remove_layer (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_rename_layer (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
name | string | obligatorio. Name, socket name, or layer label. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_resize (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_cell (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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. Valor predeterminado -1. |
x | integer | Cell X coordinate. Valor predeterminado 0. |
y | integer | Cell Y coordinate. Valor predeterminado 0. |
layer | integer | Tile-layer index. Valor predeterminado 0. |
transformFlags | integer | Packed transform flag bits supplied by Paper2D. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_collision_domain (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_collision_thickness (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_hex_side_length (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_layer_collision (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_layer_color (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Valor predeterminado 1.0f. |
g | number | Green channel, 0 through 1. Valor predeterminado 1.0f. |
b | number | Blue channel, 0 through 1. Valor predeterminado 1.0f. |
a | number | Alpha channel, 0 through 1. Valor predeterminado 1.0f. |
layer | integer | Optional layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_layer_hidden_editor (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_layer_hidden_game (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | boolean | Requested switch value. Valor predeterminado false. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_layer_separation (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_material (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_pixels_per_unit (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_projection (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_tile_separation_x (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_tile_separation_y (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | number | Requested numeric value. Valor predeterminado 0.0f. |
index | integer | Optional secondary index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_map_set_tile_size (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_set_add_terrain (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
name | string | obligatorio. Name, socket name, or layer label. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_set_clear_tile_collision (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_set_clear_tile_user_data (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_set_find_tile_from_uv (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: values, items, count.
paper.tile_set_get (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: item, notes.
paper.tile_set_get_grid (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.tile_set_get_tile (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: values, items, count.
paper.tile_set_get_tile_collision (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: values, items, count.
paper.tile_set_get_tile_uv (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: values, items, count.
paper.tile_set_get_tile_xy (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
value | integer | Requested integer value. Valor predeterminado 0. |
index | integer | Optional secondary integer such as layer index. Valor predeterminado 0. |
Devuelve: values, items, count.
paper.tile_set_list_terrain (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Paper2D asset object path, component object path, or |
Devuelve: values, items, count.
paper.tile_set_set_background_color (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
r | number | Red channel, 0 through 1. Valor predeterminado 1.0f. |
g | number | Green channel, 0 through 1. Valor predeterminado 1.0f. |
b | number | Blue channel, 0 through 1. Valor predeterminado 1.0f. |
a | number | Alpha channel, 0 through 1. Valor predeterminado 1.0f. |
layer | integer | Optional layer index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_set_set_border_margin (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_set_set_drawing_offset (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_set_set_sheet (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Sprite or tile-set asset object path. |
texture | string | obligatorio. Texture2D asset object path. |
Devuelve: item, notes.
paper.tile_set_set_spacing (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_set_set_tile_size (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
x | integer | X coordinate in pixels or tile cells. Valor predeterminado 0. |
y | integer | Y coordinate in pixels or tile cells. Valor predeterminado 0. |
layer | integer | Optional layer index. Valor predeterminado 0. |
width | integer | Optional width in pixels or cells. Valor predeterminado 0. |
height | integer | Optional height in pixels or cells. Valor predeterminado 0. |
Devuelve: item, notes.
paper.tile_set_set_tile_user_data (riesgo 2, modifica, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Target Paper2D asset, component object path, or |
name | string | obligatorio. Name, socket name, or layer label. |
index | integer | Optional target index. Valor predeterminado 0. |
Devuelve: item, notes.
paper.validate_folder (riesgo 0, requiere el plugin Paper2D, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search, such as /Game/2D. |
nameContains | string | Case-insensitive name fragment. |
limit | integer | Maximum returned assets, 1 through 1000. Valor predeterminado 100. |
Devuelve: items, count.