Back to Node List

Rule Render

rule_render

Resolves a RuleCanvas with a RuleTileSet and RuleSet, then renders it to an image.

Reviewed
Guide available
The node name and summary are available in English. Port, parameter, and article details are currently shown in Japanese.

Input Ports

NameTypeDescription
ルールタイル素材
asset
RuleTileAsset
タイルセットとルールセットの束ねです(個別入力より優先)。
警告
warnings
Text
ルール未接続や配置リスト補正の警告です。
ルールキャンバス
canvas
RuleCanvas
解決するルールキャンバスです。未接続時は配置リストから作ります。
配置リスト
cells
List<Any>
ルールキャンバス入力がない時に使う配置指示リストです。
ルールタイルセット
tile_set
RuleTileSet
描画に使うルールタイル画像セットです。
ルールセット
rule_set
RuleSet
どのタイルを置くか決めるルールセットです。

Output Ports

NameTypeDescription
ルールキャンバス
canvas
RuleCanvas
今回使ったルールキャンバスです。
解決済みルール配置
resolved
RuleResolved
各セルに置くタイルが決まった結果です。
画像
image
Image
描画結果の画像です。
配置タイル数
tile_count
Int
実際に置かれたタイル数です。
概要
summary
Text
結果の短い説明です。

Parameters

NameTypeDefaultRangeDescription / Options
キャンバス名
canvas_name
Text
Rule Canvas

配置リストからルールキャンバスを作る時の名前です。

レイヤー名
layer_name
Text
Layer 1

配置リストから作るレイヤー名です。

width
Int
81–4096

配置リストから作るキャンバスの横マス数です。

高さ
height
Int
81–4096

配置リストから作るキャンバスの縦マス数です。

表示時刻(ms)
time_ms
Float
00–600000 / step 1

アニメーションタイルのフレームを選ぶ時刻(ms)です。静止タイルには影響しません。

フレーム番号
frame_index
Int
-1-1–4096

-1 の時は表示時刻(ms)を使います。0以上を指定すると フレーム番号 ÷ fps の時刻で描画します。

FPS
fps
Int
81–60

フレーム番号指定の時に使う1秒あたりのフレーム数です。

配置リストの読み方
cell_mode
Enum
TileIndex

配置リストの値をどう読むかです。

  • タイル番号TileIndex
    配置リストをタイルセット内の番号として読みます。
  • タイルIDTileId
    配置リストをタイルIDとして読みます。
  • 素材IDMaterialId
    配置リストを素材IDとして読みます。

Overview

A render node that resolves a rule canvas and turns it into an image. Rule Canvas provides its own preview, but use this node to compare different tile sets or rules on the same canvas, or to render a specific animated-tile frame at a chosen time.

Usage tips

  • Connect a different tile set and rules to the same canvas to swap its appearance, for example sharing one canvas between day and night maps.
  • Promote time_ms to an input pin 📌 to drive animated tiles by time. Use rule_animation_render to output every frame at once.
  • The output is a regular Image, ready for downstream finishing filters.

Related nodes

  • rule_canvas — supplies the canvas to resolve
  • rule_animation_render — creates a sheet containing all frames
  • rule_set_preset / rule_set_editor — supply tile sets and rules
  • tiled_map_export — exports resolved data

What this node does

For each cell in a RuleCanvas (or placement list), evaluates the rule set's neighborhood conditions to choose a tile, then outputs both the resolved result (RuleResolved) and the rendered image.

If a placement list is shorter than the map, missing cells are padded as Empty; extra entries are ignored. Negative indices, non-integer floats, and unsupported values also become Empty while rendering continues. Counts for each case are reported in warnings. MaterialId fallback without a connected RuleSet is also reported there.

Animated-tile time selection

ID Name Description
time_ms Display time (ms) Time used to select animated-tile frames. Can be promoted to a variable or animation input.
frame_index Frame index Disabled at -1. A value of 0 or more renders at the time frame index ÷ fps.
fps FPS Used when selecting by frame index.

To output every frame together, use Rule Animation Render.

Example wiring

RuleCanvas.canvas      -> RuleRender.canvas
RuleSetPreset.tile_set -> RuleRender.tile_set
RuleSetPreset.rule_set -> RuleRender.rule_set
RuleRender.resolved    -> TiledMapExport.resolved
Back to Node List
Rule Render — PixPipeline Node Reference