Adventure Creator  1.79.1
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2022
AC.ArrowPrompt Class Reference
Inheritance diagram for AC.ArrowPrompt:
AC.iActionListAssetReferencer

Public Member Functions

void DrawArrows ()
 
void TurnOn ()
 Enables the ArrowPrompt. More...
 
void TurnOff ()
 Disables the ArrowPrompt. More...
 
void DoUp ()
 
void DoDown ()
 
void DoLeft ()
 
void DoRight ()
 
bool ReferencesAsset (ActionListAsset actionListAsset)
 
virtual List< ActionListAssetGetReferencedActionListAssets ()
 

Public Attributes

ActionListSource source
 
ArrowPromptType arrowPromptType = ArrowPromptType.KeyAndClick
 
Arrow upArrow
 
Arrow downArrow
 
Arrow leftArrow
 
Arrow rightArrow
 
bool disableHotspots = true
 
float positionFactor = 1f
 
float scaleFactor = 1f
 

Protected Member Functions

void OnEnable ()
 
void Start ()
 
void OnDisable ()
 
Rect GetUpRect (float scale=0.05f)
 
Rect GetDownRect (float scale=0.05f)
 
Rect GetLeftRect (float scale=0.05f)
 
Rect GetRightRect (float scale=0.05f)
 
void Disable ()
 
IEnumerator FadeIn ()
 
IEnumerator FadeOut (AC_Direction direction)
 
void SetGUIAlpha (float alpha)
 

Protected Attributes

bool isOn = false
 
AC_Direction directionToAnimate
 
float alpha = 0f
 
float arrowSize = 0.05f
 

Properties

float LargeSize [get]
 
float SmallSize [get]
 

Detailed Description

This component provides the ability to display up to four arrows on-screen. Each arrow responds to player input, and can run an ActionList when the relevant input is detected.

Member Function Documentation

◆ DoDown()

void AC.ArrowPrompt.DoDown ( )

Triggers the "down" arrow.

◆ DoLeft()

void AC.ArrowPrompt.DoLeft ( )

Triggers the "left" arrow.

◆ DoRight()

void AC.ArrowPrompt.DoRight ( )

Triggers the "right" arrow.

◆ DoUp()

void AC.ArrowPrompt.DoUp ( )

Triggers the "up" arrow.

◆ DrawArrows()

void AC.ArrowPrompt.DrawArrows ( )

Draws the arrow(s) on screen, if appropriate. This function is called every frame by StateHandler.

◆ TurnOff()

void AC.ArrowPrompt.TurnOff ( )

Disables the ArrowPrompt.

◆ TurnOn()

void AC.ArrowPrompt.TurnOn ( )

Enables the ArrowPrompt.

Member Data Documentation

◆ arrowPromptType

ArrowPromptType AC.ArrowPrompt.arrowPromptType = ArrowPromptType.KeyAndClick

What kind of input the arrows respond to (KeyOnly, ClickOnly, KeyAndClick)

◆ disableHotspots

bool AC.ArrowPrompt.disableHotspots = true

If True, then Hotspots will be disabled when the arrows are on screen

◆ downArrow

Arrow AC.ArrowPrompt.downArrow

The "down" Arrow

◆ leftArrow

Arrow AC.ArrowPrompt.leftArrow

The "left" Arrow

◆ positionFactor

float AC.ArrowPrompt.positionFactor = 1f

A factor for the arrow position

◆ rightArrow

Arrow AC.ArrowPrompt.rightArrow

The "right" Arrow

◆ scaleFactor

float AC.ArrowPrompt.scaleFactor = 1f

A factor for the arrow size

◆ source

ActionListSource AC.ArrowPrompt.source

Where the Actions are stored when not being run (InScene, AssetFile)

◆ upArrow

Arrow AC.ArrowPrompt.upArrow

The "up" Arrow