Adventure Creator  1.68.3
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2018
AC.SettingsManager Class Reference
Inheritance diagram for AC.SettingsManager:

Public Member Functions

void ShowGUI ()
 
bool PlayerCanReverse ()
 Checks if the movement settings are such that the player character is able to reverse More...
 
bool IsFirstPersonDragRotation ()
 Checks if the game is in first-person, on touch screen, and dragging affects only the camera rotation. More...
 
bool IsFirstPersonDragComplex ()
 Checks if the game is in first-person, on touch screen, and dragging one finger affects camera rotation, and two fingers affects player movement. More...
 
bool IsFirstPersonDragMovement ()
 Checks if the game is in first-person, on touch screen, and dragging affects player movement and camera rotation. More...
 
int GetDefaultPlayerID ()
 Gets the ID number of the default Player prefab. More...
 
Player GetPlayer (int ID)
 Gets a Player prefab with a given ID number. More...
 
PlayerPrefab GetPlayerPrefab (int ID)
 Gets a PlayerPrefab class with a given ID number, if player-switching is allowed. More...
 
int GetEmptyPlayerID ()
 Gets the ID number of the first-assigned Player prefab. More...
 
Player GetDefaultPlayer (bool showError=true)
 Gets the default Player prefab. More...
 
void SetDefaultPlayer (Player defaultPlayer)
 Sets the default Player prefab. More...
 
bool CanClickOffInteractionMenu ()
 Checks if the player can click off Interaction menus to disable them. More...
 
bool MouseOverForInteractionMenu ()
 Checks if the player brings up the Interaction Menu by hovering the mouse over a Hotspot. More...
 
bool ShouldCloseInteractionMenu ()
 Checks if the Interaction menu should be closed based on the current click/tap. More...
 
SelectInteractions SelectInteractionMethod ()
 Gets the method of selecting Interactions, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction. More...
 
bool ShowHoverInteractionInHotspotLabel ()
 Checks if the interaction method is ChooseInteractionThenHotspot, and if the Hotspot label should change when hovering over an Interaction icon. More...
 
bool IsInLoadingScene ()
 Checks if the game is currently in a "loading" scene. More...
 
bool IsInFirstPerson ()
 Checks if the game is played in first-person. More...
 
bool CanGiveItems ()
 Checks if the player is able to "give" inventory items to NPCs. More...
 
bool CanSelectItems (bool showError)
 Checks if inventory items can be selected and then used on Hotspots or other items. More...
 
bool CanDragCursor ()
 Checks if the cursor can be dragged on a touch-screen. More...
 
bool ReleaseClickInteractions ()
 Checks if Interactions are triggered by "clicking up" over a MenuInteraction element. More...
 
float GetDestinationThreshold (float offset=0.1f)
 Gets the minimum distance that a character can be to its target to be considered "close enough". More...
 

Public Attributes

string saveFileName = ""
 
SaveTimeDisplay saveTimeDisplay = SaveTimeDisplay.DateOnly
 
string customSaveFormat = "MMMM dd, yyyy"
 
bool takeSaveScreenshots
 
bool useProfiles = false
 
int maxSaves = 5
 
bool orderSavesByUpdateTime = false
 
bool reloadSceneWhenLoading = false
 
bool useJsonSerialization = false
 
List< InvVarsceneAttributes = new List<InvVar>()
 
ActionListAsset actionListOnStart
 
bool blackOutWhenSkipping = false
 
PlayerSwitching playerSwitching = PlayerSwitching.DoNotAllow
 
Player player
 
List< PlayerPrefabplayers = new List<PlayerPrefab>()
 
MovementMethod movementMethod = MovementMethod.PointAndClick
 
InputMethod inputMethod = InputMethod.MouseAndKeyboard
 
AC_InteractionMethod interactionMethod = AC_InteractionMethod.ContextSensitive
 
SelectInteractions selectInteractions = SelectInteractions.ClickingMenu
 
bool autoHideInteractionIcons = true
 
CancelInteractions cancelInteractions = CancelInteractions.CursorLeavesMenuOrHotspot
 
SeeInteractions seeInteractions = SeeInteractions.ClickOnHotspot
 
bool closeInteractionMenuIfTapHotspot = true
 
bool stopPlayerOnClickHotspot = false
 
bool cycleInventoryCursors = true
 
bool scaleCursorSpeedWithScreen = true
 
bool autoCycleWhenInteract = false
 
bool showHoverInteractionInHotspotLabel = false
 
bool allowDefaultinteractions = false
 
WhenReselectHotspot whenReselectHotspot = WhenReselectHotspot.RestoreHotspotIcon
 
bool lockCursorOnStart = false
 
bool hideLockedCursor = false
 
bool disableFreeAimWhenDragging = false
 
bool runConversationsWithKeys = false
 
bool clickUpInteractions = false
 
bool defaultMouseClicks = true
 
bool allowGameplayDuringConversations = false
 
bool shareInventory = false
 
bool inventoryDragDrop = false
 
float dragDropThreshold = 0
 
bool allowInventoryInteractionsDuringConversations = false
 
bool inventoryDropLook = false
 
InventoryInteractions inventoryInteractions = InventoryInteractions.Single
 
bool inventoryDisableLeft = true
 
bool allowDefaultInventoryInteractions = false
 
bool inventoryDisableUnhandled = true
 
bool inventoryDisableDefined = true
 
bool activeWhenHover = false
 
InventoryActiveEffect inventoryActiveEffect = InventoryActiveEffect.Simple
 
float inventoryPulseSpeed = 1f
 
bool activeWhenUnhandled = true
 
bool canReorderItems = false
 
SelectInventoryDisplay selectInventoryDisplay = SelectInventoryDisplay.NoChange
 
RightClickInventory rightClickInventory = RightClickInventory.DeselectsItem
 
bool reverseInventoryCombinations = false
 
bool canMoveWhenActive = true
 
bool selectInvWithUnhandled = false
 
int selectInvWithIconID = 0
 
bool giveInvWithUnhandled = false
 
int giveInvWithIconID = 0
 
bool autoDisableUnhandledHotspots = false
 
Transform clickPrefab
 
float walkableClickRange = 0.5f
 
NavMeshSearchDirection navMeshSearchDirection = NavMeshSearchDirection.RadiallyOutwardsFromCursor
 
DoubleClickMovement doubleClickMovement = DoubleClickMovement.MakesPlayerRun
 
bool magnitudeAffectsDirect = false
 
bool directTurnsInstantly = false
 
bool disableMovementWhenInterationMenusAreOpen = false
 
DirectMovementType directMovementType = DirectMovementType.RelativeToCamera
 
LimitDirectMovement limitDirectMovement = LimitDirectMovement.NoLimit
 
bool directMovementPerspective = false
 
float destinationAccuracy = 0.8f
 
bool experimentalAccuracy = false
 
float pathfindUpdateFrequency = 0f
 
float verticalReductionFactor = 0.7f
 
bool rotationsAffectedByVerticalReduction = true
 
float jumpSpeed = 4f
 
bool singleTapStraight = false
 
bool singleTapStraightPathfind = false
 
float clickHoldSeparationStraight = 0.3f
 
bool useFPCamDuringConversations = true
 
bool onlyInteractWhenCursorUnlocked = false
 
float freeAimSmoothSpeed = 50f
 
bool assumeInputsDefined = false
 
List< ActiveInputactiveInputs = new List<ActiveInput>()
 
float freeAimTouchSpeed = 0.01f
 
float dragWalkThreshold = 5f
 
float dragRunThreshold = 20f
 
bool drawDragLine = false
 
float dragLineWidth = 3f
 
Color dragLineColor = Color.white
 
bool offsetTouchCursor = false
 
bool doubleTapHotspots = true
 
FirstPersonTouchScreen firstPersonTouchScreen = FirstPersonTouchScreen.OneTouchToMoveAndTurn
 
DirectTouchScreen directTouchScreen = DirectTouchScreen.DragBased
 
bool touchUpWhenPaused = false
 
bool forceAspectRatio = false
 
float wantedAspectRatio = 1.5f
 
bool landscapeModeOnly = true
 
CameraPerspective cameraPerspective = CameraPerspective.ThreeD
 
MovingTurning movingTurning = MovingTurning.Unity2D
 
HotspotDetection hotspotDetection = HotspotDetection.MouseOver
 
bool closeInteractionMenusIfPlayerLeavesVicinity = false
 
bool placeDistantHotspotsOnSeparateLayer = true
 
HotspotsInVicinity hotspotsInVicinity = HotspotsInVicinity.NearestOnly
 
HotspotIconDisplay hotspotIconDisplay = HotspotIconDisplay.Never
 
HotspotIcon hotspotIcon
 
Texture2D hotspotIconTexture = null
 
float hotspotIconSize = 0.04f
 
bool playerFacesHotspots = false
 
bool onlyFaceHotspotOnSelect = false
 
bool scaleHighlightWithMouseProximity = false
 
float highlightProximityFactor = 4f
 
bool occludeIcons = false
 
bool hideIconUnderInteractionMenu = false
 
ScreenWorld hotspotDrawing = ScreenWorld.ScreenSpace
 
bool hideUnhandledHotspots = false
 
float navMeshRaycastLength = 100f
 
float hotspotRaycastLength = 100f
 
float moveableRaycastLength = 30f
 
string hotspotLayer = "Default"
 
string distantHotspotLayer = "DistantHotspot"
 
string navMeshLayer = "NavMesh"
 
string backgroundImageLayer = "BackgroundImage"
 
string deactivatedLayer = "Ignore Raycast"
 
bool useLoadingScreen = false
 
ChooseSceneBy loadingSceneIs = ChooseSceneBy.Number
 
string loadingSceneName = ""
 
int loadingScene = 0
 
bool useAsyncLoading = false
 
float loadingDelay = 0f
 
bool playMusicWhilePaused = false
 
List< MusicStoragemusicStorages = new List<MusicStorage>()
 
List< MusicStorageambienceStorages = new List<MusicStorage>()
 
VolumeControl volumeControl = VolumeControl.AudioSources
 
AudioMixerGroup musicMixerGroup = null
 
AudioMixerGroup sfxMixerGroup = null
 
AudioMixerGroup speechMixerGroup = null
 
string musicAttentuationParameter = "musicVolume"
 
string sfxAttentuationParameter = "sfxVolume"
 
string speechAttentuationParameter = "speechVolume"
 
int defaultLanguage = 0
 
int defaultVoiceLanguage = 0
 
bool defaultShowSubtitles = false
 
float defaultSfxVolume = 0.9f
 
float defaultMusicVolume = 0.6f
 
float defaultSpeechVolume = 1f
 
ShowDebugLogs showDebugLogs = ShowDebugLogs.Always
 
bool printActionCommentsInConsole = false
 
DebugWindowDisplays showActiveActionLists = DebugWindowDisplays.Never
 
bool showHierarchyIcons = true
 

Properties

SeeInteractions SeeInteractions [get]
 
RightClickInventory RightClickInventory [get]
 
string SavePrefix [get]
 
bool InventoryDragDrop [get]
 
bool AutoDisableUnhandledHotspots [get]
 

Detailed Description

Handles the "Settings" tab of the Game Editor window. Most game-wide settings, including those related to control, input and interactions, are stored here.

Member Function Documentation

◆ CanClickOffInteractionMenu()

bool AC.SettingsManager.CanClickOffInteractionMenu ( )

Checks if the player can click off Interaction menus to disable them.

Returns
True if the player can click off Interaction menus to disable them.

◆ CanDragCursor()

bool AC.SettingsManager.CanDragCursor ( )

Checks if the cursor can be dragged on a touch-screen.

Returns
True if the cursor can be dragged on a touch-screen

◆ CanGiveItems()

bool AC.SettingsManager.CanGiveItems ( )

Checks if the player is able to "give" inventory items to NPCs.

Returns
True if the player is able to "give" inventory items to NPCs.

◆ CanSelectItems()

bool AC.SettingsManager.CanSelectItems ( bool  showError)

Checks if inventory items can be selected and then used on Hotspots or other items.

Parameters
showErrorIf True, then a warning will be sent to the Console if this function returns False
Returns
Checks if inventory items can be selected and then used on Hotspots or other items

◆ GetDefaultPlayer()

Player AC.SettingsManager.GetDefaultPlayer ( bool  showError = true)

Gets the default Player prefab.

Parameters
showErrorIf True, and no default Player is found, a warning message will be printed in the Console
Returns
The default player Player prefab

◆ GetDefaultPlayerID()

int AC.SettingsManager.GetDefaultPlayerID ( )

Gets the ID number of the default Player prefab.

Returns
The ID number of the default Player prefab

◆ GetDestinationThreshold()

float AC.SettingsManager.GetDestinationThreshold ( float  offset = 0.1f)

Gets the minimum distance that a character can be to its target to be considered "close enough".

Parameters
offsetThe calculation is 1 + offset - destinationAccuracy, so having a non-zero offset prevents the result ever being zero.
Returns
The minimum distance that a character can be to its target to be considered "close enough".

◆ GetEmptyPlayerID()

int AC.SettingsManager.GetEmptyPlayerID ( )

Gets the ID number of the first-assigned Player prefab.

Returns
The ID number of the first-assigned Player prefab

◆ GetPlayer()

Player AC.SettingsManager.GetPlayer ( int  ID)

Gets a Player prefab with a given ID number.

Parameters
IDThe ID number of the Player prefab to return
Returns
The Player prefab with the given ID number.

◆ GetPlayerPrefab()

PlayerPrefab AC.SettingsManager.GetPlayerPrefab ( int  ID)

Gets a PlayerPrefab class with a given ID number, if player-switching is allowed.

Parameters
IDThe ID number of the PlayerPrefab class to return
Returns
The PlayerPrefab class with the given ID number. This will return null if playerSwitching = PlayerSwitching.DoNotAllow

◆ IsFirstPersonDragComplex()

bool AC.SettingsManager.IsFirstPersonDragComplex ( )

Checks if the game is in first-person, on touch screen, and dragging one finger affects camera rotation, and two fingers affects player movement.

Returns
True if the game is in first-person, on touch screen, and dragging one finger affects camera rotation, and two fingers affects player movement.

◆ IsFirstPersonDragMovement()

bool AC.SettingsManager.IsFirstPersonDragMovement ( )

Checks if the game is in first-person, on touch screen, and dragging affects player movement and camera rotation.

Returns
True if the game is in first-person, on touch screen, and dragging affects player movement and camera rotation.

◆ IsFirstPersonDragRotation()

bool AC.SettingsManager.IsFirstPersonDragRotation ( )

Checks if the game is in first-person, on touch screen, and dragging affects only the camera rotation.

Returns
True if the game is in first-person, on touch screen, and dragging affects only the camera rotation.

◆ IsInFirstPerson()

bool AC.SettingsManager.IsInFirstPerson ( )

Checks if the game is played in first-person.

Returns
True if the game is played in first-person

◆ IsInLoadingScene()

bool AC.SettingsManager.IsInLoadingScene ( )

Checks if the game is currently in a "loading" scene.

Returns
True it the game is currently in a "loading" scene

◆ MouseOverForInteractionMenu()

bool AC.SettingsManager.MouseOverForInteractionMenu ( )

Checks if the player brings up the Interaction Menu by hovering the mouse over a Hotspot.

Returns
True if the player brings up the Interaction Menu by hovering the mouse over a Hotspot.

◆ PlayerCanReverse()

bool AC.SettingsManager.PlayerCanReverse ( )

Checks if the movement settings are such that the player character is able to reverse

Returns
True if the movement settings are such that the player character is able to reverse

◆ ReleaseClickInteractions()

bool AC.SettingsManager.ReleaseClickInteractions ( )

Checks if Interactions are triggered by "clicking up" over a MenuInteraction element.

Returns
True if Interactions are triggered by "clicking up" over a MenuInteraction element

◆ SelectInteractionMethod()

SelectInteractions AC.SettingsManager.SelectInteractionMethod ( )

Gets the method of selecting Interactions, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction.

Returns
The method of selecting Interactions, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction.

◆ SetDefaultPlayer()

void AC.SettingsManager.SetDefaultPlayer ( Player  defaultPlayer)

Sets the default Player prefab.

Parameters
defaultPlayerThe Player prefab to assign as the default.

◆ ShouldCloseInteractionMenu()

bool AC.SettingsManager.ShouldCloseInteractionMenu ( )

Checks if the Interaction menu should be closed based on the current click/tap.

Returns
True if the Interaction menu should be closed based on the current click/tap.

◆ ShowGUI()

void AC.SettingsManager.ShowGUI ( )

Shows the GUI.

◆ ShowHoverInteractionInHotspotLabel()

bool AC.SettingsManager.ShowHoverInteractionInHotspotLabel ( )

Checks if the interaction method is ChooseInteractionThenHotspot, and if the Hotspot label should change when hovering over an Interaction icon.

Returns
True if the interaction method is ChooseInteractionThenHotspot, and if the Hotspot label should change when hovering over an Interaction icon.

Member Data Documentation

◆ actionListOnStart

ActionListAsset AC.SettingsManager.actionListOnStart

The ActionListAsset to run when the game begins

◆ activeInputs

List<ActiveInput> AC.SettingsManager.activeInputs = new List<ActiveInput>()

A List of active inputs that trigger ActionLists when an Input button is pressed

◆ activeWhenHover

bool AC.SettingsManager.activeWhenHover = false

If True, then an inventory item will show its "active" texture when the mouse hovers over it

◆ activeWhenUnhandled

bool AC.SettingsManager.activeWhenUnhandled = true

If True, then the inventory item will show its active effect when hovering over a Hotspot that has no matching Interaction

◆ allowDefaultinteractions

bool AC.SettingsManager.allowDefaultinteractions = false

If True, and interactionMethod = AC_InteractionMethod.ChooseInteractionThenHotspot, then invoking the 'DefaultInteractions' input button will run the first-enabled 'Use' interaction of the active Hotspot

◆ allowDefaultInventoryInteractions

bool AC.SettingsManager.allowDefaultInventoryInteractions = false

If True, interactionMethod = AC_InteractionMethod.ChooseInteractionThenHotspot and inventoryInteractions = InventoryInteractions.Multiple, then invoking the 'DefaultInteractions' input button will run the first-enabled 'Standard' interaction of the active Inventory item

◆ allowGameplayDuringConversations

bool AC.SettingsManager.allowGameplayDuringConversations = false

If True, then gameplay is allowed during Conversations

◆ allowInventoryInteractionsDuringConversations

bool AC.SettingsManager.allowInventoryInteractionsDuringConversations = false

If True, inventory can be interacted with while a Conversation is active (overridden by allowGameplayDuringConversations)

◆ ambienceStorages

List<MusicStorage> AC.SettingsManager.ambienceStorages = new List<MusicStorage>()

A list of all AudioClips that can be played as ambience using the "Sound: Play ambience" Action

◆ assumeInputsDefined

bool AC.SettingsManager.assumeInputsDefined = false

If True, then try/catch statements used when checking for input will be bypassed - this results in better performance, but all available inputs must be defined.

◆ autoCycleWhenInteract

bool AC.SettingsManager.autoCycleWhenInteract = false

If True, then triggering an Interaction will cycle the cursor mode, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction

◆ autoDisableUnhandledHotspots

bool AC.SettingsManager.autoDisableUnhandledHotspots = false

If True, Hotspots that have no interaction associated with a given inventory item will not be active while that item is selected

◆ autoHideInteractionIcons

bool AC.SettingsManager.autoHideInteractionIcons = true

If True, then Interaction icons will be hidden if linked to a Hotspot or InvItem that has no interaction linked to that icon

◆ backgroundImageLayer

string AC.SettingsManager.backgroundImageLayer = "BackgroundImage"

The layer to place BackgroundImage prefabs on

◆ blackOutWhenSkipping

bool AC.SettingsManager.blackOutWhenSkipping = false

If True, then the game will turn black whenever the user triggers the "EndCutscene" input to skip a cutscene

◆ cameraPerspective

CameraPerspective AC.SettingsManager.cameraPerspective = CameraPerspective.ThreeD

The game's camera perspective (TwoD, TwoPointFiveD, ThreeD)

◆ cancelInteractions

CancelInteractions AC.SettingsManager.cancelInteractions = CancelInteractions.CursorLeavesMenuOrHotspot

The method to close Interaction menus, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction (ClickOffMenu, CursorLeavesMenu, CursorLeavesMenuOrHotspot)

◆ canMoveWhenActive

bool AC.SettingsManager.canMoveWhenActive = true

If True, then the player can move while an inventory item is selected

◆ canReorderItems

bool AC.SettingsManager.canReorderItems = false

If True, then inventory items can be re-ordered in a MenuInventoryBox by the player

◆ clickHoldSeparationStraight

float AC.SettingsManager.clickHoldSeparationStraight = 0.3f

The duration in seconds that separates a single click/tap from a held click/tap when movementMethod = AC_MovementMethod.StraightToCursor

◆ clickPrefab

Transform AC.SettingsManager.clickPrefab

A prefab to instantiate whenever the user clicks to move the player, if movementMethod = AC_MovementMethod.PointAndClick

◆ clickUpInteractions

bool AC.SettingsManager.clickUpInteractions = false

If True, then interactions can be triggered by releasing the mouse cursor over an icon, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction

◆ closeInteractionMenuIfTapHotspot

bool AC.SettingsManager.closeInteractionMenuIfTapHotspot = true

If True, then Interaction Menus can be closed by tapping another Hotspot for which they are opened.

◆ closeInteractionMenusIfPlayerLeavesVicinity

bool AC.SettingsManager.closeInteractionMenusIfPlayerLeavesVicinity = false

If True, and hotspotDetection = HotspotDetection.PlayerVicinity and interactionMethod = InteractionMethod.ChooseHotspotThenInteraction, then Interaction Menus will close if the Player is no longer in the active Hotspot's vicinity

◆ customSaveFormat

string AC.SettingsManager.customSaveFormat = "MMMM dd, yyyy"

The format of time display for save game labels, if saveTimeDisplay = SaveTimeDisplay.CustomFormat

◆ cycleInventoryCursors

bool AC.SettingsManager.cycleInventoryCursors = true

If True, then inventory items will be included in Interaction menus / cursor cycles, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction

◆ deactivatedLayer

string AC.SettingsManager.deactivatedLayer = "Ignore Raycast"

The layer to place deactivated objects on

◆ defaultLanguage

int AC.SettingsManager.defaultLanguage = 0

The game's default language index

◆ defaultMouseClicks

bool AC.SettingsManager.defaultMouseClicks = true

If True, and inputMethod = InputMethod.MouseAndKeyboard, then left and right mouse clicks will have default behaviour

◆ defaultMusicVolume

float AC.SettingsManager.defaultMusicVolume = 0.6f

The game's default music audio volume

◆ defaultSfxVolume

float AC.SettingsManager.defaultSfxVolume = 0.9f

The game's default SFX audio volume

◆ defaultShowSubtitles

bool AC.SettingsManager.defaultShowSubtitles = false

The game's default subtitles state

◆ defaultSpeechVolume

float AC.SettingsManager.defaultSpeechVolume = 1f

The game's default speech audio volume

◆ defaultVoiceLanguage

int AC.SettingsManager.defaultVoiceLanguage = 0

The game's default voice language index (if SpeechManager.separateVoiceAndTextLanguages = True)

◆ destinationAccuracy

float AC.SettingsManager.destinationAccuracy = 0.8f

How accurate characters will be when navigating to set points on a NavMesh

◆ directMovementPerspective

bool AC.SettingsManager.directMovementPerspective = false

If True, then the player's position on screen will be accounted for, if directMovementType = DirectMovementType.RelativeToCamera

◆ directMovementType

DirectMovementType AC.SettingsManager.directMovementType = DirectMovementType.RelativeToCamera

How the player moves, if movementMethod = AC_MovementMethod.Direct (RelativeToCamera, TankControls)

◆ directTouchScreen

DirectTouchScreen AC.SettingsManager.directTouchScreen = DirectTouchScreen.DragBased

How Direct movement should work when using touch-screen controls (DragBased, CustomInput)

◆ directTurnsInstantly

bool AC.SettingsManager.directTurnsInstantly = false

If True, and movementMethod = AC_MovementMethod.Direct, then the Player will turn instantly when moving during gameplay

◆ disableFreeAimWhenDragging

bool AC.SettingsManager.disableFreeAimWhenDragging = false

If True, and the game is in first-person, then free-aiming will be disabled while a moveable object is dragged

◆ disableMovementWhenInterationMenusAreOpen

bool AC.SettingsManager.disableMovementWhenInterationMenusAreOpen = false

If True, and Interaction menus are used, movement will be prevented while they are on

◆ distantHotspotLayer

string AC.SettingsManager.distantHotspotLayer = "DistantHotspot"

The layer to place distant Hotspots on, if hotspotDetection = HotspotDetection.PlayerVicinity

◆ doubleClickMovement

DoubleClickMovement AC.SettingsManager.doubleClickMovement = DoubleClickMovement.MakesPlayerRun

If movementMethod = AC_MovementMethod.PointAndClick, what effect double-clicking has on player movement

◆ doubleTapHotspots

bool AC.SettingsManager.doubleTapHotspots = true

If True, then Hotspots are activated by double-tapping (if inputMethod = AC_InputMethod.TouchScreen)

◆ dragDropThreshold

float AC.SettingsManager.dragDropThreshold = 0

The number of pixels the mouse must be dragged for the inventory drag-drop effect becomes active, if inventoryDragDrop = True

◆ dragLineColor

Color AC.SettingsManager.dragLineColor = Color.white

The colour of the drag line, if drawDragLine = True

◆ dragLineWidth

float AC.SettingsManager.dragLineWidth = 3f

The width of the drag line, if drawDragLine = True

◆ dragRunThreshold

float AC.SettingsManager.dragRunThreshold = 20f

The minimum drag magnitude needed to make the player run, if movementMethod = AC_MovementMethod.Drag

◆ dragWalkThreshold

float AC.SettingsManager.dragWalkThreshold = 5f

The minimum drag magnitude needed to move the player, if movementMethod = AC_MovementMethod.Drag

◆ drawDragLine

bool AC.SettingsManager.drawDragLine = false

If True, then a drag line will be drawn on screen if movementMethod = AC_MovementMethod.Drag

◆ experimentalAccuracy

bool AC.SettingsManager.experimentalAccuracy = false

If True, and destinationAccuracy = 1, then characters will lerp to their destination when very close, to ensure they end up at exactly the intended point

◆ firstPersonTouchScreen

FirstPersonTouchScreen AC.SettingsManager.firstPersonTouchScreen = FirstPersonTouchScreen.OneTouchToMoveAndTurn

How First Person movement should work when using touch-screen controls (OneTouchToMoveAndTurn, OneTouchToTurnAndTwoTouchesToMove, TouchControlsTurningOnly, CustomInput)

◆ forceAspectRatio

bool AC.SettingsManager.forceAspectRatio = false

If True, then the game's aspect ratio will be fixed

◆ freeAimSmoothSpeed

float AC.SettingsManager.freeAimSmoothSpeed = 50f

The acceleration for free-aiming smoothing

◆ freeAimTouchSpeed

float AC.SettingsManager.freeAimTouchSpeed = 0.01f

The free-look speed when rotating a first-person camera, if inputMethod = AC_InputMethod.TouchScreen

◆ giveInvWithIconID

int AC.SettingsManager.giveInvWithIconID = 0

The ID number of the CursorIcon interaction that selects the inventory item (in "give" mode) when unhandled, if selectInvWithUnhandled = True

◆ giveInvWithUnhandled

bool AC.SettingsManager.giveInvWithUnhandled = false

If True, and inventoryInteraction = InventoryInteractions.Multiple, then the item will be selected (in "give" mode) if a particular Interaction is unhandled

◆ hideIconUnderInteractionMenu

bool AC.SettingsManager.hideIconUnderInteractionMenu = false

If True, then Hotspot icons will be hidden if an Interaction Menu is visible

◆ hideLockedCursor

bool AC.SettingsManager.hideLockedCursor = false

If True, then the cursor will be hidden whenever it is locked

◆ hideUnhandledHotspots

bool AC.SettingsManager.hideUnhandledHotspots = false

If True, and interactionMethod = AC_InteractionMethod.ChooseInteractionThenHotspot, then Hotspots that do not have an interaction for the currently-selected icon will not be visible to the cursor

◆ highlightProximityFactor

float AC.SettingsManager.highlightProximityFactor = 4f

The factor by which distance affects the highlighting of Hotspots, if scaleHighlightWithMouseProximity = True

◆ hotspotDetection

HotspotDetection AC.SettingsManager.hotspotDetection = HotspotDetection.MouseOver

How Hotspots are detected (MouseOver, PlayerVicinity, CustomScript)

◆ hotspotDrawing

ScreenWorld AC.SettingsManager.hotspotDrawing = ScreenWorld.ScreenSpace

How to draw Hotspot icons (ScreenSpace, WorldSpace)

◆ hotspotIcon

HotspotIcon AC.SettingsManager.hotspotIcon

The type of Hotspot icon to display, if hotspotIconDisplay != HotspotIconDisplay.Never (Texture, UseIcon)

◆ hotspotIconDisplay

HotspotIconDisplay AC.SettingsManager.hotspotIconDisplay = HotspotIconDisplay.Never

When Hotspot icons are displayed (Never, Always, OnlyWhenHighlighting, OnlyWhenFlashing)

◆ hotspotIconSize

float AC.SettingsManager.hotspotIconSize = 0.04f

The size of Hotspot icons

◆ hotspotIconTexture

Texture2D AC.SettingsManager.hotspotIconTexture = null

The texture to use for Hotspot icons, if hotspotIcon = HotspotIcon.Texture

◆ hotspotLayer

string AC.SettingsManager.hotspotLayer = "Default"

The layer to place active Hotspots on

◆ hotspotRaycastLength

float AC.SettingsManager.hotspotRaycastLength = 100f

The length of rays cast to find Hotspots

◆ hotspotsInVicinity

HotspotsInVicinity AC.SettingsManager.hotspotsInVicinity = HotspotsInVicinity.NearestOnly

What Hotspots gets detected, if hotspotDetection = HotspotDetection.PlayerVicinity (NearestOnly, CycleMultiple, ShowAll)

◆ inputMethod

InputMethod AC.SettingsManager.inputMethod = InputMethod.MouseAndKeyboard

The main input method used to control the game with (MouseAndKeyboard, KeyboardOrController, TouchScreen)

◆ interactionMethod

AC_InteractionMethod AC.SettingsManager.interactionMethod = AC_InteractionMethod.ContextSensitive

How Hotspots are interacted with (ContextSensitive, ChooseInteractionThenHotspot, ChooseHotspotThenInteraction)

◆ inventoryActiveEffect

InventoryActiveEffect AC.SettingsManager.inventoryActiveEffect = InventoryActiveEffect.Simple

The effect to apply to an active inventory item's icon (None, Pulse, Simple)

◆ inventoryDisableDefined

bool AC.SettingsManager.inventoryDisableDefined = true

If True, then triggering a defined Inventory interaction will-deselect the active inventory item

◆ inventoryDisableLeft

bool AC.SettingsManager.inventoryDisableLeft = true

If True, then left-clicking will de-select an inventory item

◆ inventoryDisableUnhandled

bool AC.SettingsManager.inventoryDisableUnhandled = true

If True, then triggering an unhandled Inventory interaction will de-select the active inventory item

◆ inventoryDragDrop

bool AC.SettingsManager.inventoryDragDrop = false

If True, then inventory items can be drag-dropped (i.e. used on Hotspots and other items with a single mouse button press

◆ inventoryDropLook

bool AC.SettingsManager.inventoryDropLook = false

If True, then using an inventory item on itself will trigger its Examine interaction

◆ inventoryInteractions

InventoryInteractions AC.SettingsManager.inventoryInteractions = InventoryInteractions.Single

How many interactions an inventory item can have (Single, Multiple)

◆ inventoryPulseSpeed

float AC.SettingsManager.inventoryPulseSpeed = 1f

The speed at which to pulse the active inventory item's icon, if inventoryActiveEffect = InventoryActiveEffect.Pulse

◆ jumpSpeed

float AC.SettingsManager.jumpSpeed = 4f

The player's jump speed

◆ landscapeModeOnly

bool AC.SettingsManager.landscapeModeOnly = true

If True, then the game can only be played in landscape mode (iPhone only)

◆ limitDirectMovement

LimitDirectMovement AC.SettingsManager.limitDirectMovement = LimitDirectMovement.NoLimit

How to limit the player's moement, if directMovementType = DirectMovementType.RelativeToCamera

◆ loadingDelay

float AC.SettingsManager.loadingDelay = 0f

The delay, in seconds, before and after loading, if both useLoadingScreen = True and useAsyncLoading = True

◆ loadingScene

int AC.SettingsManager.loadingScene = 0

The number of the scene to act as a loading scene, if loadingScene = ChooseSceneBy.Number

◆ loadingSceneIs

ChooseSceneBy AC.SettingsManager.loadingSceneIs = ChooseSceneBy.Number

How the scene that acts as a loading scene is chosen (Number, Name)

◆ loadingSceneName

string AC.SettingsManager.loadingSceneName = ""

The name of the scene to act as a loading scene, if loadingScene = ChooseSceneBy.Name

◆ lockCursorOnStart

bool AC.SettingsManager.lockCursorOnStart = false

If True, then the cursor will be locked in the centre of the screen when the game begins

◆ magnitudeAffectsDirect

bool AC.SettingsManager.magnitudeAffectsDirect = false

If True, and movementMethod = AC_MovementMethod.Direct, then the magnitude of the input axis will affect the Player's speed

◆ maxSaves

int AC.SettingsManager.maxSaves = 5

The maximum number of save files that can be created

◆ moveableRaycastLength

float AC.SettingsManager.moveableRaycastLength = 30f

The length of rays cast to find moveable objects (see DragBase)

◆ movementMethod

MovementMethod AC.SettingsManager.movementMethod = MovementMethod.PointAndClick

How the player character is controlled (PointAndClick, Direct, FirstPerson, Drag, None, StraightToCursor)

◆ movingTurning

MovingTurning AC.SettingsManager.movingTurning = MovingTurning.Unity2D

The method of moving and turning in 2D games (Unity2D, TopDown, ScreenSpace, WorldSpace)

◆ musicAttentuationParameter

string AC.SettingsManager.musicAttentuationParameter = "musicVolume"

The name of the parameter in musicMixerGroup that controls attenuation

◆ musicMixerGroup

AudioMixerGroup AC.SettingsManager.musicMixerGroup = null

The AudioMixerGroup for music audio, if volumeControl = VolumeControl.AudioSources

◆ musicStorages

List<MusicStorage> AC.SettingsManager.musicStorages = new List<MusicStorage>()

A list of all AudioClips that can be played as music using the "Sound: Play music" Action

◆ navMeshLayer

string AC.SettingsManager.navMeshLayer = "NavMesh"

The layer to place active NavMeshes on

◆ navMeshRaycastLength

float AC.SettingsManager.navMeshRaycastLength = 100f

The length of rays cast to find NavMeshes

◆ navMeshSearchDirection

NavMeshSearchDirection AC.SettingsManager.navMeshSearchDirection = NavMeshSearchDirection.RadiallyOutwardsFromCursor

How the nearest NavMesh to a cursor click is found, in screen space, if the user doesn't click directly on one

◆ occludeIcons

bool AC.SettingsManager.occludeIcons = false

If True, then Hotspot icons will be hidden behind colldiers placed on hotspotLayer

◆ offsetTouchCursor

bool AC.SettingsManager.offsetTouchCursor = false

If True, then the cursor is not set to the touch point, but instead is moved by dragging (if inputMethod = AC_InputMethod.TouchScreen)

◆ onlyFaceHotspotOnSelect

bool AC.SettingsManager.onlyFaceHotspotOnSelect = false

If true, and playerFacesHotspots = True, and interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction, then players will only turn their heads once a Hotspot has been selected

◆ onlyInteractWhenCursorUnlocked

bool AC.SettingsManager.onlyInteractWhenCursorUnlocked = false

If True, then Hotspot interactions are only allowed if the cursor is unlocked (first person-games only)

◆ orderSavesByUpdateTime

bool AC.SettingsManager.orderSavesByUpdateTime = false

If True, then save files listed in MenuSaveList will be displayed in order of update time

◆ pathfindUpdateFrequency

float AC.SettingsManager.pathfindUpdateFrequency = 0f

If >0, the time (in seconds) between pathfinding recalculations occur

◆ placeDistantHotspotsOnSeparateLayer

bool AC.SettingsManager.placeDistantHotspotsOnSeparateLayer = true

If True, and hotspotDetection = HotspotDetection.PlayerVicinity, then distant Hotspots will be placed on a different layer

◆ player

Player AC.SettingsManager.player

The player prefab, if playerSwitching = PlayerSwitching.DoNotAllow

◆ playerFacesHotspots

bool AC.SettingsManager.playerFacesHotspots = false

If True, then 3D player prefabs will turn their head towards the active Hotspot

◆ players

List<PlayerPrefab> AC.SettingsManager.players = new List<PlayerPrefab>()

All available player prefabs, if playerSwitching = PlayerSwitching.Allow

◆ playerSwitching

PlayerSwitching AC.SettingsManager.playerSwitching = PlayerSwitching.DoNotAllow

The state of player-switching (Allow, DoNotAllow)

◆ playMusicWhilePaused

bool AC.SettingsManager.playMusicWhilePaused = false

If True, then music can play when the game is paused

◆ printActionCommentsInConsole

bool AC.SettingsManager.printActionCommentsInConsole = false

If True, comments attached to Actions will be printed in the Console when the Action is run

◆ reloadSceneWhenLoading

bool AC.SettingsManager.reloadSceneWhenLoading = false

If True, then the scene will reload when loading a saved game that takes place in the same scene that the player is already in

◆ reverseInventoryCombinations

bool AC.SettingsManager.reverseInventoryCombinations = false

If True, then invntory item combinations will also work in reverse

◆ rightClickInventory

RightClickInventory AC.SettingsManager.rightClickInventory = RightClickInventory.DeselectsItem

What happens when right-clicking while an inventory item is selected (ExaminesItem, DeselectsItem, DoesNothing)

◆ rotationsAffectedByVerticalReduction

bool AC.SettingsManager.rotationsAffectedByVerticalReduction = true

If True, then rotations of 2D characters will be affected by the verticalReductionFactor value

◆ runConversationsWithKeys

bool AC.SettingsManager.runConversationsWithKeys = false

If True, then Conversation dialogue options can be triggered with the number keys

◆ saveFileName

string AC.SettingsManager.saveFileName = ""

The name to give save game files

◆ saveTimeDisplay

SaveTimeDisplay AC.SettingsManager.saveTimeDisplay = SaveTimeDisplay.DateOnly

How the time of a save file should be displayed (None, DateOnly, TimeAndDate, CustomFormat)

◆ scaleCursorSpeedWithScreen

bool AC.SettingsManager.scaleCursorSpeedWithScreen = true

If True, and inputMethod = InputMethod.KeyboardOrController, then the speed of the cursor will be proportional to the size of the screen

◆ scaleHighlightWithMouseProximity

bool AC.SettingsManager.scaleHighlightWithMouseProximity = false

If True, then Hotspots will highlight according to how close the cursor is to them

◆ sceneAttributes

List<InvVar> AC.SettingsManager.sceneAttributes = new List<InvVar>()

The game's full list of inventory item properties

◆ seeInteractions

SeeInteractions AC.SettingsManager.seeInteractions = SeeInteractions.ClickOnHotspot

How Interaction menus are opened, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction (ClickOnHotspot, CursorOverHotspot)

◆ selectInteractions

SelectInteractions AC.SettingsManager.selectInteractions = SelectInteractions.ClickingMenu

How Interactions are triggered, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction (ClickingMenu, CyclingCursorAndClickingHotspot, CyclingMenuAndClickingHotspot)

◆ selectInventoryDisplay

SelectInventoryDisplay AC.SettingsManager.selectInventoryDisplay = SelectInventoryDisplay.NoChange

How the currently-selected inventory item should be displayed in InventoryBox elements

◆ selectInvWithIconID

int AC.SettingsManager.selectInvWithIconID = 0

The ID number of the CursorIcon interaction that selects the inventory item (in "use" mode) when unhandled, if selectInvWithUnhandled = True

◆ selectInvWithUnhandled

bool AC.SettingsManager.selectInvWithUnhandled = false

If True, and inventoryInteraction = InventoryInteractions.Multiple, then the item will be selected (in "use" mode) if a particular Interaction is unhandled

◆ sfxAttentuationParameter

string AC.SettingsManager.sfxAttentuationParameter = "sfxVolume"

The name of the parameter in sfxMixerGroup that controls attenuation

◆ sfxMixerGroup

AudioMixerGroup AC.SettingsManager.sfxMixerGroup = null

The AudioMixerGroup for SF audio, if volumeControl = VolumeControl.AudioSources

◆ shareInventory

bool AC.SettingsManager.shareInventory = false

If True, then all player prefabs will share the same inventory, if playerSwitching = PlayerSwitching.Allow

◆ showActiveActionLists

DebugWindowDisplays AC.SettingsManager.showActiveActionLists = DebugWindowDisplays.Never

Used to show all currently-running ActionLists will be listed in the corner of the screen

◆ showDebugLogs

ShowDebugLogs AC.SettingsManager.showDebugLogs = ShowDebugLogs.Always

Determines when logs are written to the Console (Always, OnlyInEditor, Never)

◆ showHierarchyIcons

bool AC.SettingsManager.showHierarchyIcons = true

If True, then icons can be displayed in the Hierarchy window

◆ showHoverInteractionInHotspotLabel

bool AC.SettingsManager.showHoverInteractionInHotspotLabel = false

If True, and interactionMethod = AC_InteractionMethod.ChooseInteractionThenHotspot, then the Hotspot label will show the name of the interaction icon being hovered over

◆ singleTapStraight

bool AC.SettingsManager.singleTapStraight = false

If True, then single-clicking also moves the player, if movementMethod = AC_MovementMethod.StraightToCursor

◆ singleTapStraightPathfind

bool AC.SettingsManager.singleTapStraightPathfind = false

If True, then single-clicking will make the player pathfind, if singleTapStraight = True

◆ speechAttentuationParameter

string AC.SettingsManager.speechAttentuationParameter = "speechVolume"

The name of the parameter in speechMixerGroup that controls attenuation

◆ speechMixerGroup

AudioMixerGroup AC.SettingsManager.speechMixerGroup = null

The AudioMixerGroup for speech audio, if volumeControl = VolumeControl.AudioSources

◆ stopPlayerOnClickHotspot

bool AC.SettingsManager.stopPlayerOnClickHotspot = false

If True, then the player will stop when a Hotspot is clicked on, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction

◆ takeSaveScreenshots

bool AC.SettingsManager.takeSaveScreenshots

If True, then a screenshot of the game will be taken whenever the game is saved

◆ touchUpWhenPaused

bool AC.SettingsManager.touchUpWhenPaused = false

If True, then clicks while the game is paused are performed by releasing a touch, rather than beginning one

◆ useAsyncLoading

bool AC.SettingsManager.useAsyncLoading = false

If True, scenes will be loaded asynchronously

◆ useFPCamDuringConversations

bool AC.SettingsManager.useFPCamDuringConversations = true

If True, then first-person games will use the first-person camera during conversations (overridden by allowGameplayDuringConversations)

◆ useJsonSerialization

bool AC.SettingsManager.useJsonSerialization = false

If True, then Json serialization will be used instead (Unity 5.3 and above only)

◆ useLoadingScreen

bool AC.SettingsManager.useLoadingScreen = false

If True, then a specific scene will be loaded in-between scene transitions, to be used as a loading screen

◆ useProfiles

bool AC.SettingsManager.useProfiles = false

If True, then multiple save profiles - each with its own save files and options data - can be created

◆ verticalReductionFactor

float AC.SettingsManager.verticalReductionFactor = 0.7f

How much slower vertical movement is compared to horizontal movement, if the game is in 2D

◆ volumeControl

VolumeControl AC.SettingsManager.volumeControl = VolumeControl.AudioSources

How volume is controlled (AudioSources, AudioMixerGroups) (Unity 5 only)

◆ walkableClickRange

float AC.SettingsManager.walkableClickRange = 0.5f

How much of the screen will be searched for a suitable NavMesh, if the user doesn't click directly on one (it movementMethod = AC_MovementMethod.PointAndClick)

◆ wantedAspectRatio

float AC.SettingsManager.wantedAspectRatio = 1.5f

The aspect ratio, as a decimal, to use if forceAspectRatio = True

◆ whenReselectHotspot

WhenReselectHotspot AC.SettingsManager.whenReselectHotspot = WhenReselectHotspot.RestoreHotspotIcon

What happens to the cursor icon when a hotspot (or inventory item, depending) is reselected and selectInteractions = SelectInteractions.CyclingMenuAndClickingHotspot

Property Documentation

◆ AutoDisableUnhandledHotspots

bool AC.SettingsManager.AutoDisableUnhandledHotspots
get

If True, Hotspots that have no interaction associated with a given inventory item will not be active while that item is selected

◆ InventoryDragDrop

bool AC.SettingsManager.InventoryDragDrop
get

If True, then inventory items can be drag-dropped (i.e. used on Hotspots and other items with a single mouse button press

◆ RightClickInventory

RightClickInventory AC.SettingsManager.RightClickInventory
get

What happens when right-clicking while an inventory item is selected (ExaminesItem, DeselectsItem, DoesNothing).

◆ SavePrefix

string AC.SettingsManager.SavePrefix
get

The prefix of the project's save-game filesnames, before the save / profile ID

◆ SeeInteractions

SeeInteractions AC.SettingsManager.SeeInteractions
get

How Interaction menus are opened, if interactionMethod = AC_InteractionMethod.ChooseHotspotThenInteraction (ClickOnHotspot, CursorOverHotspot)