Class LocationBasedActionSpecBuilder

Namespace

S1API.Entities.Schedule

Assembly

S1API.dll

Fluent sub-builder for composing a LocationBasedActionSpec with type-safe arrive behavior selection.

public sealed class LocationBasedActionSpecBuilder

Inheritance

object

LocationBasedActionSpecBuilder

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Methods

FaceDestinationDirection(bool)

Sets whether the NPC should face destination direction while walking.

public LocationBasedActionSpecBuilder FaceDestinationDirection(bool value = true)

Parameters

value bool

Whether to face destination direction.

Returns

LocationBasedActionSpecBuilder

This sub-builder for chaining.

Named(string)

Sets an explicit action name for the generated location-based schedule action.

public LocationBasedActionSpecBuilder Named(string value)

Parameters

value string

Custom action name.

Returns

LocationBasedActionSpecBuilder

This sub-builder for chaining.

OnArriveDrinking()

Finalizes this location-based action to trigger drinking action on arrival.

public PrefabScheduleBuilder OnArriveDrinking()

Returns

PrefabScheduleBuilder

The parent schedule builder for continued chaining.

OnArriveGraffiti()

Finalizes this location-based action to trigger graffiti behavior on arrival.

public PrefabScheduleBuilder OnArriveGraffiti()

Returns

PrefabScheduleBuilder

The parent schedule builder for continued chaining.

OnArriveHoldItem()

Finalizes this location-based action to trigger item holding action on arrival.

public PrefabScheduleBuilder OnArriveHoldItem()

Returns

PrefabScheduleBuilder

The parent schedule builder for continued chaining.

OnArriveNone()

Finalizes this location-based action with no arrive behavior.

public PrefabScheduleBuilder OnArriveNone()

Returns

PrefabScheduleBuilder

The parent schedule builder for continued chaining.

OnArriveSmokeBreak()

Finalizes this location-based action to trigger smoke break behavior on arrival.

public PrefabScheduleBuilder OnArriveSmokeBreak()

Returns

PrefabScheduleBuilder

The parent schedule builder for continued chaining.

WarpIfSkipped(bool)

Sets whether to warp the NPC to destination if the action is skipped.

public LocationBasedActionSpecBuilder WarpIfSkipped(bool value = true)

Parameters

value bool

Whether to warp if skipped.

Returns

LocationBasedActionSpecBuilder

This sub-builder for chaining.

WithDrink(EquippablePath)

For Drinking: specify which drink to use. Call before OnArriveDrinking().

public LocationBasedActionSpecBuilder WithDrink(EquippablePath drinkEquippablePath)

Parameters

drinkEquippablePath EquippablePath

Use EquippablePath (e.g. Beer) or pass custom path string.

Returns

LocationBasedActionSpecBuilder

This sub-builder for chaining.

WithItem(EquippablePath)

For HoldItem: specify which item to hold. Call before OnArriveHoldItem().

public LocationBasedActionSpecBuilder WithItem(EquippablePath equippablePath)

Parameters

equippablePath EquippablePath

Use EquippablePath (e.g. Phone_Lowered) or pass custom path string.

Returns

LocationBasedActionSpecBuilder

This sub-builder for chaining.

WithSpraySurface(SpraySurface)

For Graffiti: use a specific spray surface. Call before OnArriveGraffiti().

public LocationBasedActionSpecBuilder WithSpraySurface(SpraySurface surface)

Parameters

surface SpraySurface

The spray surface (e.g. from FindNearestUntaggedSurface(Vector3?)).

Returns

LocationBasedActionSpecBuilder

This sub-builder for chaining.

WithSpraySurface(Guid)

For Graffiti: use a specific spray surface by GUID. Call before OnArriveGraffiti().

public LocationBasedActionSpecBuilder WithSpraySurface(Guid guid)

Parameters

guid Guid

The surface GUID (from GUID).

Returns

LocationBasedActionSpecBuilder

This sub-builder for chaining.

WithSpraySurfaceInRegion(Region)

For Graffiti: pick a spray surface in the given region. Call before OnArriveGraffiti().

public LocationBasedActionSpecBuilder WithSpraySurfaceInRegion(Region region)

Parameters

region Region

The map region to search for surfaces.

Returns

LocationBasedActionSpecBuilder

This sub-builder for chaining.

Within(float)

Sets the distance threshold within which the NPC is considered to have arrived.

public LocationBasedActionSpecBuilder Within(float value)

Parameters

value float

Arrival threshold in world units.

Returns

LocationBasedActionSpecBuilder

This sub-builder for chaining.