Class PhoneCallDefinition

Namespace

S1API.PhoneCalls

Assembly

S1API.dll

Abstract base class for defining phone calls in Schedule One. Provides methods to create and configure phone call data including caller information and call stages.

public abstract class PhoneCallDefinition

Inheritance

object

PhoneCallDefinition

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

PhoneCallDefinition(NPC?)

Creates a new phone call definition using an NPC as the caller. Initializes the underlying PhoneCallData and sets up the caller information from the NPC.

protected PhoneCallDefinition(NPC? npcCallerID)

Parameters

npcCallerID NPC

The NPC instance to use for the caller information.

PhoneCallDefinition(string, Sprite?)

Public constructor used for instancing a new ScheduleOne.ScriptableObjects.PhoneCallData

protected PhoneCallDefinition(string name, Sprite? profilePicture = null)

Parameters

name string

The name of the caller

profilePicture Sprite

The sprite of the caller

Fields

Caller

The caller of the PhoneCallDefinition instance

public CallerDefinition? Caller

Field Value

CallerDefinition

S1PhoneCallData

The original ScheduleOne.ScriptableObjects.PhoneCallData instance

public readonly PhoneCallData S1PhoneCallData

Field Value

PhoneCallData

StageEntries

A list of all stage entries added to this phone call.

protected readonly List<CallStageEntry> StageEntries

Field Value

List<CallStageEntry>

Methods

AddCallerID(NPC?)

Set's a new CallerID definition based of an existing NPC instance.

protected CallerDefinition AddCallerID(NPC? npc)

Parameters

npc NPC

The NPC instance to use for the caller

Returns

CallerDefinition

A reference to the CallerID definition

AddCallerID(string, Sprite?)

Set's a new CallerID definition to the PhoneCall

protected CallerDefinition AddCallerID(string name, Sprite? profilePicture = null)

Parameters

name string

The name of the caller

profilePicture Sprite

The sprite of the caller

Returns

CallerDefinition

A reference to the CallerID definition

AddStage(string)

Add's a CallStageEntry instance to the S1PhoneCallData

protected CallStageEntry AddStage(string text)

Parameters

text string

The text to display in this stage

Returns

CallStageEntry

A reference to the Stage entry

Completed()

Completes the ScheduleOne.ScriptableObjects.PhoneCallData instance.

public void Completed()