From 1ef77b9ee566210485b5b3b7a2a7997f6c200012 Mon Sep 17 00:00:00 2001 From: StraToN Date: Fri, 8 Sep 2023 15:36:40 +0000 Subject: [PATCH] docs: Automatic update of API docs --- api/ESCItem.md | 25 ++++++++++++++++++++----- api/ESCLocation.md | 9 ++++----- 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/api/ESCItem.md b/api/ESCItem.md index d8a3e2c..e5b0612 100644 --- a/api/ESCItem.md +++ b/api/ESCItem.md @@ -20,6 +20,14 @@ character to the next room. ## Constants Descriptions +### FORBIDDEN\_CHARACTERS + +```gdscript +const FORBIDDEN_CHARACTERS: String = "['\"]" +``` + +List of forbidden characters in global_ids + ### GROUP\_ITEM\_CAN\_COLLIDE ```gdscript @@ -105,17 +113,16 @@ and be moved with commands like teleport and turn_to. export var player_orients_on_arrival = true ``` -If true, player orients towards 'interaction_direction' as +If true, player orients towards 'interaction_angle' as player character arrives. -### interaction\_direction +### interaction\_angle ```gdscript -export var interaction_direction = 0 +export var interaction_angle = 0 ``` -Let the player turn to this direction when the player arrives at the -item +Let the player turn to this angle when the player arrives at the item ### tooltip\_name @@ -264,6 +271,14 @@ Reference to this items collision shape node ## Method Descriptions +### validate\_exported\_parameters + +```gdscript +func validate_exported_parameters() -> void +``` + +Validates the various exported parameters so we get immediate crash. + ### validate\_animations ```gdscript diff --git a/api/ESCLocation.md b/api/ESCLocation.md index 9e65626..2ab54c6 100644 --- a/api/ESCLocation.md +++ b/api/ESCLocation.md @@ -46,17 +46,16 @@ If true, this ESCLocation is considered as a player start location export var player_orients_on_arrival = true ``` -If true, player orients towards 'interaction_direction' as +If true, player orients towards 'interaction_angle' as player character arrives. -### interaction\_direction +### interaction\_angle ```gdscript -export var interaction_direction = 0 +export var interaction_angle = 0 ``` -Let the player turn to this direction when the player arrives -at the item +Let the player turn to this angle when the player arrives at the item ## Method Descriptions