Components to reuse a design in other designs
1. Introduction
Components TCastleDesign and TCastleTransformDesign allow you to instantiate (reuse) in one design file a component designed in another design file. This is similar to how Unity prefabs are used.
2. Video
If you like to learn by watching, we have a nice video about using these components:
3. Overview
The general idea is simple:
-
You can reuse a composition of components, that you have designed in CGE editor, multiple times.
-
You can reuse a UI (
TCastleUserInterface). Reuse byTCastleDesign. -
You can reuse a transform (
TCastleTransform- 3D or 2D stuff that can be placed in a viewport). Reuse byTCastleTransformDesign.
Any design file (.castle-user-interface or .castle-transform) can be loaded (instantiated) by TCastleDesign and TCastleTransformDesign). To create such design file, with any component as a root, you can use:
-
Menu item "Design → New Xxx (Custom Root) → Xxx"
-
Or save any component to file using "Save Selected…" command (right-click on the component in hierarchy).
Then you can reuse it:
-
by manually adding
TCastleDesignorTCastleTransformDesignto new designs. Set theirURLproperty to the design that contains the component to be reused. -
Or just drag-and-drop a
.castle-user-interfaceor.castle-transformfile on your design.
See the context menu (right-click) of the TCastleDesign or TCastleTransformDesign for some helpful commands:
-
"Edit (Copy Here) Referenced Design" (detach from the referenced design file)
-
"Revert To Referenced Design" (use after "Edit (Copy Here) Referenced Design"; this removes all the children and reverts back to the original design file)
-
"Open Referenced Design" (an easy way to open design in the
URLof thisTCastleDesignorTCastleTransformDesigncomponent).
To improve this documentation just edit the source of this page in AsciiDoctor (simple wiki-like syntax) and create a pull request to Castle Game Engine WWW (cge-www) repository.