Class LocationBasedActionSpec

Namespace

S1API.Entities.Schedule

Assembly

S1API.dll

Specifies an action that makes an NPC walk to a destination and perform a configured action while there.

public sealed class LocationBasedActionSpec : IScheduleActionSpec

Inheritance

object

LocationBasedActionSpec

Implements

IScheduleActionSpec

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)

Remarks

This action creates a ScheduleOne.NPCs.Schedules.NPCEvent_LocationBasedAction. When the NPC arrives, the selected ArriveBehaviour is started, then stopped when the schedule event ends.

Constructors

LocationBasedActionSpec()

public LocationBasedActionSpec()

Properties

ArriveBehaviour

Gets or sets the arrive behavior to start when the NPC reaches the destination.

public LocationArriveBehaviour ArriveBehaviour { get; set; }

Property Value

LocationArriveBehaviour

Destination

Gets or sets the world position where the NPC should walk to.

public Vector3 Destination { get; set; }

Property Value

Vector3

DrinkEquippablePath

For Drinking: Resources path to the drink AvatarEquippable prefab (e.g. "Avatar/Equippables/Beer"). If null, uses the prefab's configured DrinkItem.

public string DrinkEquippablePath { get; set; }

Property Value

string

DurationMinutes

Gets or sets the duration in minutes for this action.

public int DurationMinutes { get; set; }

Property Value

int

EquippableAssetPath

For HoldItem: Resources path to the AvatarEquippable prefab (e.g. "Avatar/Equippables/Phone_Lowered"). If null, uses the prefab's configured HoldItem equippable.

public string EquippableAssetPath { get; set; }

Property Value

string

FaceDestinationDirection

Gets or sets whether the NPC should face the destination direction when walking.

public bool FaceDestinationDirection { get; set; }

Property Value

bool

GraffitiRegion

For Graffiti: optional region to pick a spray surface from. If null, nearest to destination is used.

public Region? GraffitiRegion { get; set; }

Property Value

Region?

GraffitiSurfaceGuid

For Graffiti: optional GUID of a specific spray surface. Takes precedence over GraffitiRegion.

public Guid? GraffitiSurfaceGuid { get; set; }

Property Value

Guid?

Name

Gets or sets the optional name for this action.

public string Name { get; set; }

Property Value

string

StartTime

Gets or sets the time when this action should start, in minutes from midnight.

public int StartTime { get; set; }

Property Value

int

WarpIfSkipped

Gets or sets whether the NPC should be warped to the destination if the action is skipped.

public bool WarpIfSkipped { get; set; }

Property Value

bool

Within

Gets or sets the distance threshold within which the NPC is considered to have arrived.

public float Within { get; set; }

Property Value

float