Skip to content

Class

ActionLogSettings

Generated GDScript class reference for GridPlacement.ActionLogSettings.

Status
Draft
Version
v6.0
Updated
Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Settings that define what and how the build log UI displays gameplay messaging content

Source: addons/grid_placement/resources/settings/action_log_settings.gd

Syntax

class ActionLogSettings extends PlacementResource

Members

NameKindSummary
on_ready_messagePropertyIf set, will show this when the build log starts
bullet_stylePropertyList bullet style
failed_colorProperty
success_colorProperty
show_validation_messagePropertyShow the base messages from ValidationResults
print_failed_reasonsPropertyShow the reasons for a build failing
max_failure_reasonsPropertyMaximum validation issues listed per result; the log appends an "... and N more issues" line past this cap.
issue_bullet_prefixPropertyPrefix printed before each validation issue line in the log.
print_on_drag_buildPropertyShould printing still happen for drag build. Warning: This may generate a lot of messages
print_success_reasonsPropertyWhen a build validations succeeds, print all of the success reason messages to the log
show_demolishPropertyPrint message on successful demolish
show_move_startedPropertyPrint message when move starts (pickup)
show_move_finishedPropertyPrint message when move finishes (placement/cancel)
show_manipulation_finishedPropertyPrint finished/canceled/failed lines for manipulation actions without a dedicated flag (rotate, flips, ...). MOVE and DEMOLISH keep their dedicated show_move_finished / show_demolish flags; this gates the rest. Defaults to true so existing logs read exactly as before.
show_build_finishedPropertyPrint message when a build succeeds ("Built X.", "Painted N cells ..."). Defaults to true so existing logs read exactly as before.
show_build_failedPropertyPrint message when a build fails ("Unable to build ...", "Paint failed ..."). Suppressing failures also suppresses their reason lines. Defaults to true so existing logs read exactly as before.
show_mode_changesPropertyPrint message when mode changes
mode_change_messagePropertyMessage format for mode changes (use %s for mode name)
built_messagePropertyMessage on successful build
fail_build_messagePropertyMessage on failed build
manipulation_messagePropertyMessage format for manipulation operations