Files
gymkhana-actions/docs/api/ESCLocation.md
Julian Murgia cbb64df969 Removed hardcoded global_id "player" (#359)
* Removed hardcoded global_id "player"
Removed hardcoded node name "start_position"

* docs: Automatic update of API docs

Co-authored-by: StraToN <StraToN@users.noreply.github.com>
2021-08-08 12:10:46 +02:00

1.1 KiB

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

is_start_location

export var is_start_location = false

If true, this ESCLocation is considered as a player start location

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