Table of Contents

Class BaseProperty

Namespace
S1API.Property
Assembly
S1API.dll

Represents an abstract base class for properties in the system.

public abstract class BaseProperty
Inheritance
BaseProperty
Derived
Inherited Members
Extension Methods

Constructors

BaseProperty()

protected BaseProperty()

Properties

EmployeeCapacity

Gets or sets the maximum number of employees that can be assigned to the property.

public abstract int EmployeeCapacity { get; set; }

Property Value

int

Remarks

This property represents the capacity for employees within a given property. Modifying this value impacts the operations and resource management of the property. Suitable for scenarios where resource allocation and workforce planning are essential.

IsOwned

public abstract bool IsOwned { get; }

Property Value

bool

Price

Represents the cost or monetary value associated with a property.

public abstract float Price { get; set; }

Property Value

float

A float representing the monetary price of the property.

Remarks

The Price property is a floating-point value that indicates the price for the property. It provides a read-only mechanism to access this value. This value is essential in determining the economic aspect of the property.

PropertyCode

Gets the unique code that identifies the property.

public abstract string PropertyCode { get; }

Property Value

string

Remarks

This code is typically used to differentiate between various properties within the system. It is unique to each property and can be leveraged in operations like identification, filtering, or querying.

PropertyName

Gets the name of the property.

public abstract string PropertyName { get; }

Property Value

string

Remarks

This property represents the name or title of the property entity. It retrieves the value associated with the property from the underlying system or data structure.

Methods

IsPointInside(Vector3)

Determines whether a specified point lies within the boundary of the property.

public abstract bool IsPointInside(Vector3 point)

Parameters

point Vector3

The point to check, specified as a Vector3 coordinate.

Returns

bool

true if the point is within the property's boundary; otherwise, false.

SetOwned()

Marks the property as owned. This method updates the ownership status of the property by interacting with the underlying property implementation. Typically used to signify that the property has been acquired or purchased.

public abstract void SetOwned()