Skip to content

Class

PlacementCommitAttempt

Generated GDScript class reference for GridPlacement.PlacementCommitAttempt.

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.

One commit attempt of a placement service: the report it fills, the reserved attempt id, and the world and session identity stamped on its [PlacementLifecycleResult]. Grid and smooth services share it so every commit path rejects, commits, and names its definition the same way.

Source: addons/grid_placement/placement/placement_commit_attempt.gd

Syntax

class PlacementCommitAttempt extends RefCounted

Members

NameKindSummary
MSG_BLOCKEDFieldPlayer-facing rejection messages shared by the placement services.
MSG_OCCUPIEDField
MSG_TAKENField
MSG_MOUNT_TAKENField
MSG_INSTANTIATION_FAILEDField
reportProperty
attempt_idPropertyEmpty when the service has no allocator.
world_idProperty
session_idProperty
rejectMethod
begin_commitMethod
commitMethod
definition_keyMethod