@combos-fun/plugin-renderer-render 0.0.6 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -1
- package/agent-skill.md +48 -0
- package/combos-plugin.json +11 -0
- package/package.json +20 -6
package/README.md
CHANGED
|
@@ -1,3 +1,27 @@
|
|
|
1
1
|
# @combos-fun/plugin-renderer-render
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
@combos-fun/plugin-renderer-render — part of the Combos Fun engine monorepo.
|
|
4
|
+
|
|
5
|
+
Keywords: `visibility`, `alpha`, `z-index`, `sortable`, `2d`.
|
|
6
|
+
|
|
7
|
+
## Documentation
|
|
8
|
+
|
|
9
|
+
- Per-package agent / developer notes: [`agent-skill.md`](./agent-skill.md)
|
|
10
|
+
- Machine-readable manifest: [`combos-plugin.json`](./combos-plugin.json)
|
|
11
|
+
(validated against `schemas/combos-plugin.schema.json` in the repo
|
|
12
|
+
root)
|
|
13
|
+
- Entry skill (single source of truth for AI agents working with this
|
|
14
|
+
monorepo): `skills/combos-engine-development/SKILL.md`
|
|
15
|
+
|
|
16
|
+
When consumed from npm, the manifest and agent notes are exposed as
|
|
17
|
+
stable subpaths:
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
import manifest from '@combos-fun/plugin-renderer-render/plugin-manifest';
|
|
21
|
+
// or fetch the markdown directly:
|
|
22
|
+
// require.resolve('@combos-fun/plugin-renderer-render/agent-skill')
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## License
|
|
26
|
+
|
|
27
|
+
Internal workspace package, part of the Combos Fun engine monorepo.
|
package/agent-skill.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# `@combos-fun/plugin-renderer-render` — Agent notes
|
|
2
|
+
|
|
3
|
+
Per-`GameObject` visibility / alpha / zIndex / sortable-children control
|
|
4
|
+
for the 2D pipeline. Without this plugin, every drawable is fully visible
|
|
5
|
+
at alpha 1 and zIndex 0.
|
|
6
|
+
|
|
7
|
+
## When to read
|
|
8
|
+
|
|
9
|
+
Read whenever you need to hide / fade an object, change draw order, or
|
|
10
|
+
turn on z-sorted children inside a container.
|
|
11
|
+
|
|
12
|
+
## Public API
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
import { Render, RenderSystem, type RenderParams } from '@combos-fun/plugin-renderer-render';
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
`componentName = 'Render'`, `systemName = 'Render'`.
|
|
19
|
+
|
|
20
|
+
| Field | Type | Default |
|
|
21
|
+
|-------|------|---------|
|
|
22
|
+
| `visible` | `boolean` | `true` |
|
|
23
|
+
| `alpha` | `number` | `1` |
|
|
24
|
+
| `zIndex` | `number` | `0` |
|
|
25
|
+
| `sortableChildren` | `boolean` | `false` |
|
|
26
|
+
|
|
27
|
+
## Required setup
|
|
28
|
+
|
|
29
|
+
`RendererSystem` (from `plugin-renderer`) must be added before
|
|
30
|
+
`RenderSystem`.
|
|
31
|
+
|
|
32
|
+
## Common pitfalls
|
|
33
|
+
|
|
34
|
+
| Symptom | Fix |
|
|
35
|
+
|---------|-----|
|
|
36
|
+
| Wrong stacking order | Set `sortableChildren: true` on the parent's `Render` and `zIndex` on children |
|
|
37
|
+
| Object visible despite `visible: false` | Confirm `RenderSystem` is registered |
|
|
38
|
+
| Fade has no effect | Confirm `alpha` is between 0 and 1 |
|
|
39
|
+
|
|
40
|
+
## Minimal example
|
|
41
|
+
|
|
42
|
+
```ts
|
|
43
|
+
go.addComponent(new Render({ visible: true, alpha: 1, zIndex: 5 }));
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Verification
|
|
47
|
+
|
|
48
|
+
`pnpm --filter @combos-fun/plugin-renderer-render run build`.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@combos-fun/plugin-renderer-render",
|
|
3
|
+
"pluginId": "renderer-render",
|
|
4
|
+
"category": "rendering",
|
|
5
|
+
"dimension": "2d",
|
|
6
|
+
"isCore": false,
|
|
7
|
+
"keywords": ["visibility", "alpha", "z-index", "sortable", "2d"],
|
|
8
|
+
"agentSkill": "./agent-skill.md",
|
|
9
|
+
"requires": ["@combos-fun/engine", "@combos-fun/plugin-renderer"],
|
|
10
|
+
"exports": ["Render", "RenderSystem"]
|
|
11
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@combos-fun/plugin-renderer-render",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"description": "@combos-fun/plugin-renderer-render",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"module": "dist/plugin-renderer-render.esm.js",
|
|
@@ -8,8 +8,22 @@
|
|
|
8
8
|
"unpkg": "dist/CombosFun.plugin.renderer.render.min.js",
|
|
9
9
|
"files": [
|
|
10
10
|
"index.js",
|
|
11
|
-
"dist"
|
|
11
|
+
"dist",
|
|
12
|
+
"agent-skill.md",
|
|
13
|
+
"combos-plugin.json"
|
|
12
14
|
],
|
|
15
|
+
"exports": {
|
|
16
|
+
".": {
|
|
17
|
+
"import": "./dist/plugin-renderer-render.esm.js",
|
|
18
|
+
"require": "./index.js",
|
|
19
|
+
"types": "./dist/plugin-renderer-render.d.ts"
|
|
20
|
+
},
|
|
21
|
+
"./plugin-manifest": "./combos-plugin.json",
|
|
22
|
+
"./agent-skill": "./agent-skill.md"
|
|
23
|
+
},
|
|
24
|
+
"combos": {
|
|
25
|
+
"pluginManifest": "./combos-plugin.json"
|
|
26
|
+
},
|
|
13
27
|
"types": "dist/plugin-renderer-render.d.ts",
|
|
14
28
|
"keywords": [
|
|
15
29
|
"combos-fun",
|
|
@@ -18,10 +32,10 @@
|
|
|
18
32
|
"author": "sun668 <q947692259@gmail.com>",
|
|
19
33
|
"dependencies": {
|
|
20
34
|
"pixi.js": "^8.18.1",
|
|
21
|
-
"@combos-fun/plugin-renderer": "0.0.
|
|
22
|
-
"@combos-fun/
|
|
23
|
-
"@combos-fun/engine": "0.0.
|
|
24
|
-
"@combos-fun/
|
|
35
|
+
"@combos-fun/plugin-renderer": "0.0.7",
|
|
36
|
+
"@combos-fun/renderer-adapter": "0.0.7",
|
|
37
|
+
"@combos-fun/engine": "0.0.7",
|
|
38
|
+
"@combos-fun/inspector-decorator": "0.0.7"
|
|
25
39
|
},
|
|
26
40
|
"scripts": {
|
|
27
41
|
"build": "node ../../scripts/build-package.mjs"
|