Both expanders and Prime Radiant offer the possibility to apply overlays.
Overlay is used primarily as temporary way to override specific generated files, to e.g. add more customization anchors, or change non-customizable behavior of expanded code.
Using overlays puts all maintenance responsibility on the application developers. Due to the brittleness of overlays (potentially any change in the generated code can break the application), it is recommended to use them only temporarily until the required changes are applied to the expanders.
Expanders’ Overlay Step
Expanders include an
overlay phase and an ApplicationOverlay Step that is running by default.
This step automatically copies all files from
- source file:
- destination file:
If you want to temporarily disable overlay phase,
Expand > Skip Overlays in Prime Radiant,
or add an
skipPhase : overlay expansionOption before expanding.
Prime Radiant Overlays (removed)
NOTE This functionality has been removed in Prime Radiant 2021.0.0.
Some projects may contain separate overlay script file in:
Unless you explicitly call these scripts, you should be safe to remove them.
If you have a script that you want to migrate, replace any copying step with a regular overlay step (see Expanders’ Overlay Step).
For any special step performed in the script, the recommended approach is to create a separate ExpansionStep executed in the
For reference, these environment variables were injected into the overlay script:
||Directory where the application has been expanded to.||
||Directory of the application’s model/code (typically root of a git repository).||