Skip to content

Documentation

First Person

Initializing search

View on the Asset Store

Home
Game Creator
Inventory
Dialogue
Stats
Quests
Behavior
Perception
Shooter
Melee
Traversal
Extensions

Documentation

View on the Asset Store

Home
Game Creator
Game Creator
- Getting Started
  Getting Started
- Characters
  Characters
  - Component
  - Interaction
  - Animation
    
    Animation
    
    Animator
    
    Gestures
    
    States
  - Inverse Kinematics
    
    Inverse Kinematics
    
    Feet Align
    
    Look at Target
  - Footstep Sounds
  - Ragdoll
  - Markers
  - Advanced
    
    Advanced
    
    Skeleton
    
    Character API
    
    Character Controller
    
    Custom IK
- Cameras
  Cameras
  - Camera Controller
  - Camera Shots
- Visual Scripting
  Visual Scripting
  - Actions
    
    Actions
    
    Instructions
    
    Instructions
    
    Animator
    
    Animator
    
    Change Animator Float
    
    Change Animator Integer
    
    Change Animator Layer
    
    Change Blend Shape
    
    Play Animation Clip
    
    Set Animator Boolean
    
    Set Animator Trigger
    
    Application
    
    Application
    
    Open Web Page
    
    Quit Application
    
    Cursor
    
    Cursor
    
    Cursor Texture
    
    Cursor Visibility
    
    Lock Cursor
    
    Audio
    
    Audio
    
    Audio Mixer Parameter
    
    Change Ambient volume
    
    Change Master volume
    
    Change Music volume
    
    Change Snapshot
    
    Change Sound Effects volume
    
    Change Speech volume
    
    Change UI volume
    
    Fade all Ambient
    
    Fade all Music
    
    Play Ambient
    
    Play Music
    
    Play Sound Effect
    
    Play Speech
    
    Play UI sound
    
    Stop Ambient
    
    Stop Music
    
    Stop Sound Effect
    
    Stop Speech on Game Object
    
    Cameras
    
    Cameras
    
    Change to Shot
    
    Revert to Previous Shot
    
    Set Main Shot
    
    Properties
    
    Properties
    
    Change Culling Mask
    
    Change Field of View
    
    Change Orthographic Size
    
    Change Projection
    
    Shakes
    
    Shakes
    
    Shake Camera Burst
    
    Shake Camera Sustain
    
    Stop Camera Sustain Shake
    
    Stop Camera Shake Bursts
    
    Shots
    
    Shots
    
    Anchor
    
    Anchor
    
    Change Distance
    
    Change Offset
    
    Change Target
    
    Animation
    
    Animation
    
    Change Duration
    
    First person
    
    First person
    
    Change Max Pitch
    
    Change Offset
    
    Change Sensitivity
    
    Change Smooth Time
    
    Change Target
    
    Follow
    
    Follow
    
    Change Distance
    
    Change Target
    
    Head bobbing
    
    Head bobbing
    
    Enable Head Bobbing
    
    Head leaning
    
    Head leaning
    
    Enable Head Leaning
    
    Lock on
    
    Lock on
    
    Change Anchor
    
    Change Distance
    
    Change Offset
    
    Look
    
    Look
    
    Change Offset
    
    Change Target
    
    Enable Look
    
    Orbit
    
    Orbit
    
    Change Alignment
    
    Change Max Pitch
    
    Change Max Radius
    
    Change Offset
    
    Change Sensitivity
    
    Change Smooth Time
    
    Change Target
    
    Zoom
    
    Zoom
    
    Change Level Zoom
    
    Change Min Distance
    
    Change Smooth Time
    
    Characters
    
    Characters
    
    Animation
    
    Animation
    
    Change Exertion
    
    Change Heart Rate
    
    Change Smooth Time
    
    Change State Weight
    
    Change Twitching
    
    Enter State
    
    Play Gesture
    
    Stop Gestures
    
    Stop State
    
    Combat
    
    Combat
    
    Invincibility
    
    Invincibility
    
    Set Invincible
    
    Poise
    
    Poise
    
    Set Poise
    
    Targeting
    
    Targeting
    
    Add Target Candidate
    
    Clear Target
    
    Cycle Closest Target
    
    Cycle Direction Target
    
    Cycle Next Target
    
    Cycle Previous Target
    
    Remove Target Candidate
    
    Set Target
    
    Footsteps
    
    Footsteps
    
    Change Footstep Sounds
    
    Play Footstep
    
    Ik
    
    Ik
    
    Active Feet IK
    
    Active Lean IK
    
    Active Look IK
    
    Start Looking At
    
    Stop Looking At
    
    Interaction
    
    Interaction
    
    Interact
    
    Navigation
    
    Navigation
    
    Cancel Dash
    
    Dash
    
    Jump
    
    Move Direction
    
    Move To
    
    Set Character Driver
    
    Set Character Rotation
    
    Start Following
    
    Stop Following
    
    Stop Move
    
    Teleport
    
    Player
    
    Player
    
    Change Player
    
    Set Player Input
    
    Properties
    
    Properties
    
    Can Collide
    
    Can Jump
    
    Change Angular Speed
    
    Change Gravity
    
    Change Height
    
    Change ID
    
    Change Jump Force
    
    Change Mass
    
    Change Movement Speed
    
    Change Radius
    
    Change Terminal Velocity
    
    Change Time Mode
    
    Is Controllable
    
    Kill Character
    
    Reset Vertical Velocity
    
    Revive Character
    
    Ragdoll
    
    Ragdoll
    
    Recover from Ragdoll
    
    Start Ragdoll
    
    Visuals
    
    Visuals
    
    Attach Prop
    
    Change Model
    
    Drop Prop
    
    Put on Skin Mesh
    
    Remove Prop
    
    Take off Skin Mesh
    
    Debug
    
    Debug
    
    Beep
    
    Comment
    
    Frame Step
    
    Debug Number
    
    Debug Text
    
    Pause Editor
    
    Game objects
    
    Game objects
    
    Add Component
    
    Change Layer
    
    Change Name
    
    Change Tag
    
    Destroy
    
    Disable Collider
    
    Disable Component
    
    Disable Renderer
    
    Enable Collider
    
    Enable Component
    
    Enable Renderer
    
    Instantiate
    
    Remove Component
    
    Set Active
    
    Set Game Object
    
    Toggle Active
    
    Input
    
    Input
    
    Display Touchstick Left
    
    Display Touchstick Right
    
    Lights
    
    Lights
    
    Change Color
    
    Change Intensity
    
    Logic
    
    Logic
    
    Broadcast Message
    
    Change Hotspot Radius
    
    Check Conditions
    
    Emit Signal
    
    Invoke Method
    
    Restart Instructions
    
    Run Actions
    
    Run Conditions
    
    Run Trigger
    
    Stop Actions
    
    Stop Conditions
    
    Stop Trigger
    
    Math
    
    Math
    
    Arithmetic
    
    Arithmetic
    
    Absolute Number
    
    Add Numbers
    
    Clamp Number
    
    Cosine
    
    Divide Numbers
    
    Increment Number
    
    Multiply Numbers
    
    Set Number
    
    Sign of Number
    
    Sine
    
    Subtract Numbers
    
    Tangent
    
    Boolean
    
    Boolean
    
    AND Bool
    
    NAND Bool
    
    NOR Bool
    
    OR Bool
    
    Set Bool
    
    Toggle Bool
    
    Geometry
    
    Geometry
    
    Add Directions
    
    Add Points
    
    Clamp
    
    Cross Product
    
    Distance
    
    Dot Product
    
    Normalize
    
    Project on Plane
    
    Reflect on Plane
    
    Remap Coordinates
    
    Scale Product
    
    Set Direction
    
    Set Point
    
    Set Vector X
    
    Set Vector Y
    
    Set Vector Z
    
    Subtract Directions
    
    Subtract Points
    
    Transform to Local Direction
    
    Transform to Local Point
    
    Transform to World Direction
    
    Transform to World Point
    
    Uniform Scale
    
    Shading
    
    Shading
    
    Lerp Color
    
    Lerp Lightness
    
    Lerp Saturation
    
    Set Color
    
    Text
    
    Text
    
    Join
    
    Replace
    
    Set Text
    
    Substring
    
    Physics 2d
    
    Physics 2d
    
    Add Explosion Force 2D
    
    Add Force 2D
    
    Change Mass 2D
    
    Change Velocity 2D
    
    Gravity Scale 2D
    
    Is Kinematic 2D
    
    Physics 3d
    
    Physics 3d
    
    Add Explosion Force 3D
    
    Add Force 3D
    
    Change Mass 3D
    
    Change Velocity 3D
    
    Is Kinematic 3D
    
    Overlap Box 2D
    
    Overlap Box 3D
    
    Overlap Circle 2D
    
    Overlap Sphere 3D
    
    Trace Line 3D
    
    Use Gravity 3D
    
    Renderer
    
    Renderer
    
    Change Material Color
    
    Change Material Float
    
    Change Material Texture
    
    Change Material
    
    Change Sprite
    
    Scenes
    
    Scenes
    
    Load Scene
    
    Unload Scene
    
    Storage
    
    Storage
    
    Delete Game
    
    Load Game
    
    Load Latest Game
    
    Reset Game
    
    Save Game
    
    Testing
    
    Testing
    
    Tester
    
    Time
    
    Time
    
    Time Scale
    
    Wait Frames
    
    Wait Seconds
    
    Transforms
    
    Transforms
    
    Change Position
    
    Change Rotation
    
    Change Scale
    
    Clear Parent
    
    Look At
    
    Set Parent
    
    Ui
    
    Ui
    
    Canvas Group Alpha
    
    Canvas Group Block Raycasts
    
    Canvas Group Interactable
    
    Change Dropdown
    
    Change Font Size
    
    Change Graphic Color
    
    Change Height
    
    Change Image
    
    Change Input Field
    
    Change Slider
    
    Change Text
    
    Change Toggle
    
    Change Width
    
    Focus On
    
    Unfocus
    
    Variables
    
    Variables
    
    Clear List
    
    Collect Characters
    
    Collect Markers
    
    Filter List
    
    Loop List
    
    Move List
    
    Remove from List
    
    Reverse List
    
    Shuffle List
    
    Sort List Alphabetically
    
    Sort List by Distance
    
    Swap List
    
    Custom Instructions
  - Triggers
    
    Triggers
    
    Events
    
    Events
    
    Audio
    
    Audio
    
    On Change Ambient Volume
    
    On Change Master Volume
    
    On Change Music Volume
    
    On Change Sound Effects Volume
    
    On Change Speech Volume
    
    On Change UI Volume
    
    Cameras
    
    Cameras
    
    On Camera Change
    
    On Change from Shot
    
    On Change to Shot
    
    Characters
    
    Characters
    
    On Become NPC
    
    On Become Player
    
    On Change Model
    
    On Die
    
    On Revive
    
    Combat
    
    Combat
    
    On Defense Change
    
    On Dodge
    
    On Invincibility Change
    
    On Poise Break
    
    On Poise Change
    
    On Target Change
    
    Navigation
    
    Navigation
    
    On Dash
    
    On Jump
    
    On Land
    
    On NavLink Enter
    
    On NavLink Exit
    
    On Step
    
    Ragdoll
    
    Ragdoll
    
    On Recover Ragdoll
    
    On Start Ragdoll
    
    Input
    
    Input
    
    On Cursor Click
    
    On Input Button
    
    On Input Flick
    
    On Touch
    
    Interactive
    
    Interactive
    
    On Blur
    
    On Focus
    
    On Interact
    
    Lifecycle
    
    Lifecycle
    
    On App Focus
    
    On App Pause
    
    On App Quit
    
    On Become Invisible
    
    On Become Visible
    
    On Disable
    
    On Enable
    
    On Fixed Update
    
    On Interval
    
    On Invoke
    
    On Late Update
    
    On Start
    
    On Update
    
    Logic
    
    Logic
    
    On Hotspot Activate
    
    On Hotspot Deactivate
    
    On Receive Signal
    
    Physics
    
    Physics
    
    On Collide Exit
    
    On Collide
    
    On Trigger Enter Tag
    
    On Trigger Enter
    
    On Trigger Exit Tag
    
    On Trigger Exit
    
    On Trigger Stay
    
    Storage
    
    Storage
    
    On Delete
    
    On Load
    
    On Save
    
    Ui
    
    Ui
    
    On Deselect
    
    On Hover Enter
    
    On Hover Exit
    
    On Select
    
    Variables
    
    Variables
    
    On Global List Variable Change
    
    On Global Name Variable Change
    
    On Local List Variable Change
    
    On Local Name Variable Change
    
    Custom Events
  - Conditions
    
    Conditions
    
    Conditions
    
    Conditions
    
    Cameras
    
    Cameras
    
    Is Shot Active
    
    Characters
    
    Characters
    
    Animation
    
    Animation
    
    Has State in Layer
    
    Busy
    
    Busy
    
    Are Arms Available
    
    Are Legs Available
    
    Is Available
    
    Is Busy
    
    Is Humanoid
    
    Is Left Arm Available
    
    Is Left Leg Available
    
    Is Right Arm Available
    
    Is Right Leg Available
    
    Combat
    
    Combat
    
    Is Invincible
    
    Interaction
    
    Interaction
    
    Can Interact
    
    Navigation
    
    Navigation
    
    Is Airborne
    
    Is Dashing
    
    Is Grounded
    
    Is Idle
    
    Is Moving
    
    Raycast Floor
    
    Properties
    
    Properties
    
    Compare Mass
    
    Compare Foot Phase
    
    Compare Gravity
    
    Compare Height
    
    Compare Mass
    
    Compare Radius
    
    Compare Speed
    
    Is Controllable
    
    Is Dead
    
    Is Player
    
    Compare Jump Force
    
    Compare Terminal Velocity
    
    Visuals
    
    Visuals
    
    Has Prop Attached
    
    Game objects
    
    Game objects
    
    Compare Game Objects
    
    Compare Layer
    
    Compare Tag
    
    Does Component Exist
    
    Does Game Object Exist
    
    Is Component Enabled
    
    Is Game Object Active
    
    Input
    
    Input
    
    Is Input Held Down
    
    Is Input Pressed
    
    Is Input Released
    
    Is Key Held Down
    
    Is Key Pressed
    
    Is Key Released
    
    Is Mouse Held Down
    
    Is Mouse Pressed
    
    Is Mouse Released
    
    Math
    
    Math
    
    Arithmetic
    
    Arithmetic
    
    Compare Decimal
    
    Compare Integer
    
    Boolean
    
    Boolean
    
    Compare Bool
    
    Geometry
    
    Geometry
    
    Compare Direction
    
    Compare Distance Flat
    
    Compare Distance Vertical
    
    Compare Distance
    
    Compare Point
    
    Physics
    
    Physics
    
    Check Box 2D
    
    Check Box 3D
    
    Check Circle
    
    Check Sphere
    
    Is Kinematic
    
    Is Sleeping
    
    Raycast 2D
    
    Raycast 3D
    
    Platforms
    
    Platforms
    
    Check Platform
    
    Is Batch mode
    
    Is Console
    
    Is Editor
    
    Is Mobile
    
    Scenes
    
    Scenes
    
    Is Scene Loaded
    
    Storage
    
    Storage
    
    Has Save at Slot
    
    Has Save
    
    Text
    
    Text
    
    Text Contains
    
    Text Equals
    
    Transforms
    
    Transforms
    
    Child Count
    
    Is Child Of
    
    Is Sibling Of
    
    Custom Conditions
  - Hotspots
    
    Hotspots
    
    Spots
    
    Spots
    
    Cursor
    
    Look
    
    Look
    
    Look At
    
    Look on Focus
    
    Tooltips
    
    Tooltips
    
    Activate Object on Focus
    
    Activate Object
    
    Show Text on Focus
    
    Show Text
- Variables
  Variables
- Advanced
  Advanced
  - Audio
  - Data Structures
    
    Data Structures
    
    Unique ID
    
    Singleton
    
    Dictionary
    
    Hash Set
    
    Link List
    
    Matrix 2D
    
    Tree
    
    Ring Buffer
    
    State Machine
    
    Spatial Hash
  - Variables API
  - Properties
  - Save & Load
    
    Save & Load
    
    Custom Data
    
    Custom Save Location
    
    Remember
  - Tween
  - Custom Installs
- Releases
  Releases
Inventory
Inventory
- Setup
- Items
  Items
  - Properties
  - Sockets
  - Equipping
  - Crafting
- Bags
  Bags
  - Equipment
  - Loot Tables
- Currencies
- Merchants
- Tinkering
- Visual Scripting
  Visual Scripting
  - Conditions
    
    Conditions
    
    Inventory
    
    Inventory
    
    Can Add
    
    Has Item
    
    Has Runtime Item
    
    Is Overloaded
    
    Is Type of Item
    
    Is Usable
    
    Equipment
    
    Equipment
    
    Can Equip
    
    Is Equipment Slot Free
    
    Is Equippable
    
    Is Equipped
    
    Is Runtime Item Equipped
    
    Merchant
    
    Merchant
    
    Can Buy
    
    Can Sell
    
    Properties
    
    Properties
    
    Item has Property
    
    Runtime Item has Property
    
    Tinker
    
    Tinker
    
    Can Craft
    
    Can Dismantle
    
    Is Craftable
    
    Is Dismantable
    
    Ui
    
    Ui
    
    Is Bag UI Open
    
    Is Merchant UI Open
    
    Is Tinker UI Open
    
    Wealth
    
    Wealth
    
    Compare Wealth
  - Events
    
    Events
    
    Inventory
    
    Inventory
    
    On Add
    
    On Drop Item
    
    On Instantiate Item
    
    On Remove
    
    Equipment
    
    Equipment
    
    On Equip
    
    On Unequip
    
    Merchant
    
    Merchant
    
    On Buy
    
    On Sell
    
    Sockets
    
    Sockets
    
    On Socket Attach
    
    On Socket Detach
    
    Tinker
    
    Tinker
    
    On Craft
    
    On Dismantle
    
    Ui
    
    Ui
    
    On Close Bag UI
    
    On Close Merchant UI
    
    On Close Tinker UI
    
    On Open Bag UI
    
    On Open Merchant UI
    
    On Open Tinker UI
  - Instructions
    
    Instructions
    
    Inventory
    
    Inventory
    
    Bags
    
    Bags
    
    Add Item
    
    Add Runtime Item
    
    Drop Item
    
    Drop Runtime Item
    
    Increment Bag Height
    
    Increment Bag Width
    
    Move Content to Bag
    
    Move Wealth to Bag
    
    Remove Item
    
    Remove Runtime Item
    
    Currency
    
    Currency
    
    Change Currency
    
    Equipment
    
    Equipment
    
    Equip Item
    
    Equip Runtime Item
    
    Unequip Item
    
    Unequip Runtime Item
    
    Loot
    
    Loot
    
    Instantiate Item
    
    Loot Table
    
    Sockets
    
    Sockets
    
    Attach Runtime Item
    
    Detach Runtime Item
    
    Ui
    
    Ui
    
    Close Bag UI
    
    Close Merchant UI
    
    Close Tinker UI
    
    Open Bag UI
    
    Open Merchant UI
    
    Open Tinker UI
    
    Set Bag UI
    
    Set Transfer Amount
    
    Variables
    
    Variables
    
    Set Item
    
    Set Runtime Item
- User Interface
  User Interface
- Releases
  Releases
Dialogue
Dialogue
- Setup
- Dialogues
  Dialogues
- Actors
  Actors
  - Expressions
- Skins
  Skins
- User Interface
  User Interface
- Visual Scripting
  Visual Scripting
  - Conditions
    
    Conditions
    
    Dialogue
    
    Dialogue
    
    Dialogue Played
    
    Tag Visited
  - Events
    
    Events
    
    Dialogue
    
    Dialogue
    
    On Finish Dialogue
    
    On Start Dialogue
  - Instructions
    
    Instructions
    
    Dialogue
    
    Dialogue
    
    Play Dialogue
    
    Stop Dialogue
    
    Ui
    
    Ui
    
    Choice Index
    
    Skip Line
- Releases
  Releases
Stats
Stats
- Setup
- Classes
  Classes
  - Stats
  - Attributes
  - Classes
  - Traits
- Formulas
- Tables
- Stat Modifiers
- Status Effects
- User Interface
  User Interface
- Visual Scripting
  Visual Scripting
  - Conditions
    
    Conditions
    
    Stats
    
    Stats
    
    Check Formula
    
    Compare Attribute
    
    Compare Stat
    
    Has Status Effect
  - Events
    
    Events
    
    Stats
    
    Stats
    
    On Attribute Change
    
    On Stat Change
    
    On Status Effect Change
  - Instructions
    
    Instructions
    
    Stats
    
    Stats
    
    Add Stat Modifier
    
    Add Status Effect
    
    Change Attribute
    
    Change Stat
    
    Clear Status Effects Type
    
    Remove Stat Modifier
    
    Remove Status Effect
    
    Ui
    
    Ui
    
    Change AttributeUI Attribute
    
    Change AttributeUI Target
    
    Change StatUI Stat
    
    Change StatUI Target
    
    Change Status Effects List UI Target
- Releases
  Releases
Quests
Quests
- Setup
- Quests
  Quests
- Journal
- Visual Scripting
  Visual Scripting
  - Conditions
    
    Conditions
    
    Quests
    
    Quests
    
    Are Quests Equal
    
    Is Quest Abandoned
    
    Is Quest Active
    
    Is Quest Completed
    
    Is Quest Failed
    
    Is Quest Inactive
    
    Is Task Abandoned
    
    Is Task Active
    
    Is Task Completed
    
    Is Task Failed
    
    Is Task Inactive
    
    Groups
    
    Groups
    
    Are all Quests Completed
    
    Is any Quest Completed
  - Events
    
    Events
    
    Quests
    
    Quests
    
    On Any Quest Track
    
    On Any Quest Untrack
    
    On Quest Abandon
    
    On Quest Activate
    
    On Quest Complete
    
    On Quest Deactivate
    
    On Quest Fail
    
    On Task Abandon
    
    On Task Activate
    
    On Task Complete
    
    On Task Deactivate
    
    On Task Fail
    
    On Task Value Change
  - Instructions
    
    Instructions
    
    Quests
    
    Quests
    
    Quest Activate
    
    Quest Deactivate
    
    Quest Track
    
    Quest Untrack All
    
    Quest Untrack
    
    Set Quest
    
    Task Abandon
    
    Task Complete
    
    Task Fail
    
    Task Value
- User Interface
  User Interface
- Releases
  Releases
Behavior
Behavior
Perception
Perception
Shooter
Shooter
Melee
Melee
Traversal
Traversal
Extensions
Extensions
- Transitions
  Transitions
  - Transitions
  - Instructions
- Footsteps
  Footsteps

Table of contents

Instructions

First Person¶

Instructions¶

Change Max Pitch
Change Offset
Change Sensitivity
Change Smooth Time
Change Target

Catsoft Works © 2022