Building Area

You can find all the information about Building Area here.

This component enables the creation of boundaries within scenes to prevent Building Parts from being placed, destroyed, or edited in undesired areas, following the building rules of the area. You can specify certain areas where building is either permitted or forbidden within your scene.

You can find a guide on how to use this component on the Beginner's Guides page.

Explore fields description in the Inspector by hovering your cursor over them. You can find more information about this here: Tooltip Attribute.

API

You can access this class by including the following namespace:

using EasyBuildSystem.Features.Runtime.Buildings.Area;

Here is a list of all the events and methods of this component that can be called:

Events

/// <summary>
/// Event triggered when a Building Part is registered in the area.
/// </summary>
BuildingManager.Instance.OnRegisterBuildingPartEvent.AddListener((BuildingPart part) => { });

/// <summary>
/// Event triggered when a Building Part is unregistered from the area.
/// </summary>
BuildingManager.Instance.OnUnregisterBuildingPartEvent.AddListener((BuildingPart part) => { });

Methods

/// <summary>
/// Checks if a Building Part can be placed in this area.
/// </summary>
/// <param name="buildingPart">The Building Part to be placed.</param>
/// <returns>True if the Building Part can be placed, false otherwise.</returns>
CanPlacingBuildingPart(BuildingPart part);

/// <summary>
/// Checks if a Building Part can be destroyed in this area.
/// </summary>
/// <param name="buildingPart">The Building Part to be destroyed.</param>
/// <returns>True if the Building Part can be destroyed, false otherwise.</returns>
CanDestroyBuildingPart(BuildingPart part);

/// <summary>
/// Checks if a Building Part can be edited in this area.
/// </summary>
/// <param name="buildingPart">The Building Part to be edited.</param>
/// <returns>True if the Building Part can be edited, false otherwise.</returns>
CanEditingBuildingPart(BuildingPart part);

All of the methods related to this component can be found in the file "BuildingArea.cs". If you have any specific questions about the API, feel free to contact us.

PreviousAdvanced Guides NextBuilding Group

Last updated 1 year ago

hashtagAPI

hashtagEvents

hashtagMethods

API

Events

Methods