Show / Hide Table of Contents

Class Interactable

Inheritance
System.Object
Interactable
Animatronic
Button
Door
Drawer
KeyPickup
PortcullisDoor
SlidingDoor
Switch
Window
Implements
ILockable
IInteractable
Namespace: ShadowBox.Interactions
Assembly: cs.temp.dll.dll
Syntax
public abstract class Interactable : MonoBehaviour, ILockable, IInteractable

Fields

_canLock

Declaration
public bool _canLock
Field Value
Type Description
System.Boolean

_lockState

Declaration
public LockState _lockState
Field Value
Type Description
LockState

_startsLocked

Declaration
public bool _startsLocked
Field Value
Type Description
System.Boolean

action

Declaration
protected Prop action
Field Value
Type Description
Prop

audioSource

Declaration
public AudioSource audioSource
Field Value
Type Description
AudioSource

hingeAxis

Declaration
public RotationalAxis hingeAxis
Field Value
Type Description
RotationalAxis

initialPosition

Declaration
protected Vector3 initialPosition
Field Value
Type Description
Vector3

initialRotation

Declaration
protected Quaternion initialRotation
Field Value
Type Description
Quaternion

isMoving

Declaration
public bool isMoving
Field Value
Type Description
System.Boolean

key

Declaration
public Key key
Field Value
Type Description
Key

linkedProp

Declaration
public Interactable linkedProp
Field Value
Type Description
Interactable

movement

Declaration
public Vector2 movement
Field Value
Type Description
Vector2

onLockAudio

Declaration
public AudioClip onLockAudio
Field Value
Type Description
AudioClip

onLockedAudio

Declaration
public AudioClip onLockedAudio
Field Value
Type Description
AudioClip

onUnlockAudio

Declaration
public AudioClip onUnlockAudio
Field Value
Type Description
AudioClip

operationalSpace

Declaration
public OperationalSpace operationalSpace
Field Value
Type Description
OperationalSpace

propClosed

Declaration
public Quaternion propClosed
Field Value
Type Description
Quaternion

propName

Declaration
public string propName
Field Value
Type Description
System.String

propOpen

Declaration
public Quaternion propOpen
Field Value
Type Description
Quaternion

propType

Declaration
public InteractableType propType
Field Value
Type Description
InteractableType

showDebug

Declaration
public bool showDebug
Field Value
Type Description
System.Boolean

tmpName

Declaration
public string tmpName
Field Value
Type Description
System.String

useDuration

Declaration
public float useDuration
Field Value
Type Description
System.Single

Properties

RequiresGameObject

Declaration
public bool RequiresGameObject { get; set; }
Property Value
Type Description
System.Boolean

Methods

CalculatePosition(RotationState)

Declaration
protected Vector3 CalculatePosition(RotationState desiredState)
Parameters
Type Name Description
RotationState desiredState
Returns
Type Description
Vector3

CalculateRotation(RotationState)

Declaration
protected Quaternion CalculateRotation(RotationState state)
Parameters
Type Name Description
RotationState state
Returns
Type Description
Quaternion

CanLock()

Declaration
public bool CanLock()
Returns
Type Description
System.Boolean

GetProp()

Declaration
public Prop GetProp()
Returns
Type Description
Prop

GetPropName()

Declaration
public string GetPropName()
Returns
Type Description
System.String

GetPropType()

Declaration
public InteractableType GetPropType()
Returns
Type Description
InteractableType

GetTempPropName()

Declaration
public string GetTempPropName()
Returns
Type Description
System.String

IsLocked()

Declaration
public bool IsLocked()
Returns
Type Description
System.Boolean

Lock()

Declaration
public void Lock()

LockOnStart(Boolean)

Declaration
public void LockOnStart(bool toggle)
Parameters
Type Name Description
System.Boolean toggle

SetProp(IProp)

Declaration
public void SetProp(IProp target)
Parameters
Type Name Description
IProp target

SetPropName(String)

Declaration
public void SetPropName(string name)
Parameters
Type Name Description
System.String name

SetTempPropName(String)

Declaration
public void SetTempPropName(string name)
Parameters
Type Name Description
System.String name

SetToOne()

Declaration
public abstract void SetToOne()

SetToZero()

Declaration
public abstract void SetToZero()

ToggleLock()

Declaration
public void ToggleLock()

Unlock()

Declaration
public void Unlock()

UpdateActionDescription()

Declaration
public abstract void UpdateActionDescription()

Use()

Declaration
public abstract void Use()

Use(Transform)

Declaration
public virtual void Use(Transform target)
Parameters
Type Name Description
Transform target

Implements

ILockable
IInteractable
Back to top Generated by DocFX