Files
gymkhana-actions/docs/api/ESCLocation.md
Dennis Ploeger 604cccb56d Fix command docs, automate API doc generation (#327)
Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
2021-07-27 16:05:14 +02:00

965 B

ESCLocation

Extends: Position2D

Description

 A simple node extending Position2D with a global ID so that it can be referenced in ESC Scripts.

Property Descriptions

global_id

export var global_id = ""

The global ID of this item

player_orients_on_arrival

export var player_orients_on_arrival = true

If true, player orients towards 'interaction_direction' as player character arrives.

interaction_direction

export var interaction_direction = 0

Let the player turn to this direction when the player arrives at the item

Method Descriptions

is_class

func is_class(p_classname: String) -> bool

Used by "is" keyword to check whether a node's class_name is the same as p_classname.

## Parameters

p_classname: String class to compare against