Class PropertyWrapper

Namespace

S1API.Property

Assembly

S1API.dll

Provides an abstraction for interacting with in game player properties.

public class PropertyWrapper : BaseProperty

Inheritance

object

BaseProperty

PropertyWrapper

Derived

BusinessWrapper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Constructors

PropertyWrapper(Property)

A wrapper class that extends the functionality of BaseProperty and acts as a bridge to interact with an inner property implementation from the ScheduleOne.Property namespace.

public PropertyWrapper(Property property)

Parameters

property Property

Properties

AvailableInDemo

Gets a value indicating whether the property is available in the demo version of the game.

public bool AvailableInDemo { get; }

Property Value

bool

BuildableItemCount

Gets the number of buildable items currently placed in this property.

public int BuildableItemCount { get; }

Property Value

int

DefaultRotation

Gets the default rotation value for the property.

public float DefaultRotation { get; }

Property Value

float

EmployeeCapacity

Represents the maximum number of employees that can be allocated to the property. This property is both readable and writable, allowing for dynamic configuration of employee capacity based on the property's current requirements or constraints.

public override int EmployeeCapacity { get; set; }

Property Value

int

EmployeeCount

Gets the number of employees currently assigned to this property.

public int EmployeeCount { get; }

Property Value

int

EmployeeIdlePointCount

Gets the number of employee idle points configured for this property.

public int EmployeeIdlePointCount { get; }

Property Value

int

ExteriorSpawnPosition

Gets the exterior spawn point position of the property. This is typically used for spawning outside the property.

public Vector3 ExteriorSpawnPosition { get; }

Property Value

Vector3

InteriorSpawnPosition

Gets the interior spawn point position of the property. This is typically used for spawning inside the property.

public Vector3 InteriorSpawnPosition { get; }

Property Value

Vector3

IsContentCulled

Gets or sets a value indicating whether the property's content is currently culled. Content culling is used to optimize performance by hiding property contents when far away.

public bool IsContentCulled { get; set; }

Property Value

bool

IsOwned

Gets a value indicating whether the property is currently owned.

public override bool IsOwned { get; }

Property Value

bool

Remarks

This property reflects the ownership status of the property. Returns true if the property is owned and false otherwise. The ownership status is based on the internal state of the wrapped property implementation.

LoadingDockCount

Gets the number of loading docks available at this property.

public int LoadingDockCount { get; }

Property Value

int

NPCSpawnPosition

Gets the position of the NPC spawn point for this property. Returns Vector3.zero if no NPC spawn point is configured.

public Vector3 NPCSpawnPosition { get; }

Property Value

Vector3

Price

Gets the price of the property.

public override float Price { get; set; }

Property Value

float

Remarks

The price represents a floating-point value that denotes the monetary value or cost associated with the property. This property is both readable and writable, allowing for dynamic adjustments to the property's price.

PropertyCode

Gets the unique code representing this property. This code serves as an identifier for distinguishing the property in the system and is typically defined in the internal implementation of the property.

public override string PropertyCode { get; }

Property Value

string

PropertyName

Gets the name of the property. Represents the underlying property name as defined by its implementation.

public override string PropertyName { get; }

Property Value

string

Methods

GetEmployeeIdlePointPosition(int)

Gets the position of a specific employee idle point by index.

public Vector3 GetEmployeeIdlePointPosition(int index)

Parameters

index int

The zero-based index of the idle point.

Returns

Vector3

The position of the idle point, or Vector3.zero if the index is invalid.

GetUnassignedBedCount()

Gets the number of unassigned beds currently available in this property.

public int GetUnassignedBedCount()

Returns

int

The count of beds that do not have an assigned employee.

IsPointInside(Vector3)

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

public override 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 within the PropertyWrapper implementation. Updates the ownership status by delegating the operation to the underlying ScheduleOne.Property.Property instance. This is typically used to signify that the property has been acquired or purchased.

public override void SetOwned()