User Tools

Site Tools


pnc

Point & Click Adventure Kit

The Point & Click Adventure Kit is available on Steam as optional DLC. This page explains some of the core functionality present inside this template.

Scripting Interactions

When scripting for if the player uses an Item on themselves, see the “Source / Used” trigger. Default responses for each player state (Walk, Use, Talk, Look, Eat and Item) have already been set up and are fully changeable.

To determine which Items are used for “Combination”, refer to the same trigger. The base Item is “This” and the second Item is located in the “Held_Item” Global Variable. Use the “Held Item Branch” event to check the Items.

Input Sets

Unlike other templates, the Point & Click Adventure Kit relies solely on mouse inputs.

Cursor

Key Method Description
LMB Pressed Moves the player to current mouse position and sets current magnification of player.
LMB Released Runs the mouse up trigger.
RMB Pressed Sets the current highlighted Item as active (useable).

Custom Events

Change Map

Moves the player to a new Map with fading options.

  • P_Map - The Map in which you want the player to move to.
  • Position - The coordinates to move the player to a chosen Map.
  • P_Direction - The facing direction of the moved player.
  • P_Fade_Color - The color of the transition fade out.
  • P_Fade_Out_Time - Duration it takes to fade to your chosen color.
  • P_Fade_Delay - Duration between fading in and out.
  • P_Fade_In_Time - Duration it takes to fade back in to normal view.

Enable/Disable Letterboxing

Enables/Disables the letterboxing feature.


Held Item Branch

Takes the left branch if the selected Item is on the cursor, or the right branch if it's not.

  • P_Item - The Item currently held by the player.

Lock Camera Zoom

Locks the camera to ensure the Map always fits inside the game window.

  • P_State - Determines whether the camera is locked or unlocked.
  • P_Fit_Width - Determines whether the width of a Map is forced into camera view.
  • P_Fit_Height - Determines whether the height of a Map is forced into camera view.

Set Cursor for Change Map

Changes the cursor Sprite to show clicking in this specific area will change Maps. Only changes cursor if the user selected the “Walk” state first.


Set Vanishing Point

Changes the current vanishing point.

  • P_Vanishing_Point_Y - Determines the current Y vanishing point coordinate.
  • P_Magnification_Modifier - Determines the projected distance of a vanishing point in correlation to Actor scale.

Start/Stop Cutscene

Shows/hides the HUD, and removes the current cursor until the cutscene is completed. When re-enabled, the cursor is reset back to the default cursor.


Walk Player to Cursor (Cancelable)

Walks the player to the cursor, but right clicking will cancel the walk. Takes the left branch if the walk was successful or the right branch if it was cancelled.


Walk Player to Location (Cancelable)

Walks the player to the selected location, but right clicking will cancel the walk. Takes the left branch if the walk was successful or the right branch if it is cancelled.


Reset Cursor

Resets the cursor Sprite and behavior to the default walk cursor and behavior and removes any held Items.


Variable Definitions

Global Variables

Name Description
Vanishing_Point_Y Used to scale Actors. The Y position where the Actor's size becomes 0
Magnification_Modifier Used to scale Actors. The Actor's size is multiplied by this amount when at the bottom of the screen.
Held_Item Sets which Item the player has selected.
Change_Map_Direction Sets which direction the “Move Map” cursor faces.
Default_Eat Sets the default response for “Eating” interaction.
Default_Look Sets the default response for “Looking” interaction.
Default_Use Sets the default response for “Using” interaction.
Default_Talk Sets the default response for “Talking” interaction.
Default_Item Sets the default response for “Item” interaction.
Default_Combine Sets the default response for “Combination” interaction.
Default_Item_Walk Sets the default response for “Item Walking” interaction.

Actor Variables

Name Description
Enable_Autoscale Turns autoscaling on or off.
Base_Magnification_X / Y / Z Holds the “Base” magnification for an Actor, used for auto scaling. You need to re-set these values if you manually want to change the magnification via scripting.
Base_Speed Holds the “Base” speed for an Actor, used for auto scaling. You need to re-set this value if you manually want to change the speed via scripting.

Switches

Name Description
Lock_Camera_Zoom_X & Lock_Camera_Zoom_Y Determines if the X size and Y sizes of the displayed Map are locked to the window.
Doing_Action Used internally to check if the player is performing an action, like moving.
pnc.txt · Last modified: 2017/10/27 11:58 by AnvilHouse