Class GBActionLog

Namespace

GridPlacement.GDScript

Assembly

MoonBark.GridPlacement.GDScript.dll

Shows recent messages from the grid building plugin actions within the context of the PlacementContainer scope

class GBActionLog extends GBControl

GBActionLog

Fields

REQUIRED_DEPENDENCIES

const REQUIRED_DEPENDENCIES: Array[String] = ["_actions", "_building_state", "_manipulation_state", "_mode_state"]

Properties

message_log

Visual output area for where messages go when output from the build log

@export var message_log: RichTextLabel

current_settings

var current_settings = get_settings()

placement_rules

var placement_rules = p_container.get_placement_rules()

issues

var issues: Array[String] = p_report.get_issues()

current_settings

var current_settings = get_settings()

is_successful_value

var is_successful_value: bool = p_results.is_successful()

issues

var issues: Array[String] = p_report.get_issues()

current_settings

var current_settings = get_settings()

max_issues

var max_issues: int = min(issues.size(), current_settings.max_failure_reasons)

message

var message: String = p_data.message + "\n"

current_settings

var current_settings = get_settings()

issues_to_show

var issues_to_show: Array[String] = []

rule_result

var rule_result = p_rule_results[rule_key]

current_settings

var current_settings = get_settings()

placed_obj

var placed_obj: Node = p_data.report.placed if p_data.report else null

name

var name: String = _get_display_name_safe(preview_obj)

msg

var msg: String = current_settings.mode_change_message if not current_settings.mode_change_message.is_empty() else "Mode changed to: %s"

preview_obj

var preview_obj: Node = p_data.get_preview()

name

var name: String = _get_display_name_safe(preview_obj)

msg

var msg: String = current_settings.mode_change_message if not current_settings.mode_change_message.is_empty() else "Mode changed to: %s"

settings

var settings: ActionLogSettings = get_settings()

is_successful

var is_successful: bool = is_finished and (not p_data.results or p_data.results.is_successful())

color

var color: Color = settings.success_color if is_successful else settings.failed_color

settings

var settings: ActionLogSettings = get_settings()

current_settings

var current_settings = get_settings()

mode_name

var mode_name: String = GBEnums.Mode.keys()[p_mode]

msg

var msg: String = current_settings.mode_change_message if not current_settings.mode_change_message.is_empty() else "Mode changed to: %s"

Methods

resolve_gb_dependencies

func resolve_gb_dependencies(p_container : PlacementContainer) -> void:

Parameters

p_container

Returns

clear_log

func clear_log() -> void:

Returns

get_settings

func get_settings() -> ActionLogSettings:

Returns

validate_setup

func validate_setup() -> bool:

Returns

append_validation_results

func append_validation_results(p_results : ValidationResults):

Parameters

p_results

append_placement_report_issues

func append_placement_report_issues(p_report: PlacementReport) -> void:

Parameters

p_report

Returns

append_manipulation

func append_manipulation(p_data : ManipulationData) -> void:

Parameters

p_data

Returns

should_show

func should_show(p_action : GBEnums.Action) -> bool:

Parameters

p_action

Returns