Skip to content

Commit

Permalink
docs: Automatic update of API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
StraToN committed Sep 8, 2023
1 parent d2c6f9a commit 1ef77b9
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 10 deletions.
25 changes: 20 additions & 5 deletions api/ESCItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
9 changes: 4 additions & 5 deletions api/ESCLocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 1ef77b9

Please sign in to comment.