Skip to content

Commit

Permalink
Update API
Browse files Browse the repository at this point in the history
  • Loading branch information
StanzillaManticore committed Apr 13, 2023
1 parent 9f104b4 commit 024ca44
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 1 deletion.
1 change: 1 addition & 0 deletions src/api/damageable.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Damageable is an interface which defines properties, events, and functions for o
| ----- | ----------- | ----------- | ---- |
| `damagedEvent` | [`Event`](event.md)<`Damageable` damageable, [`Damage`](damage.md) damage> | Fired when the Damageable takes damage. | Server-Only |
| `diedEvent` | [`Event`](event.md)<`Damageable` damageable, [`Damage`](damage.md) damage> | Fired when the Damageable dies. | Server-Only |
| `hitPointsChangedEvent` | [`Event`](event.md)<`Damageable` damageable, `number` previousHitPoints> | Fired when there's a change in hit points on the Damageable. | Server-Only |

## Hooks

Expand Down
1 change: 1 addition & 0 deletions src/api/damageableobject.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ DamageableObject is a CoreObject which implements the [Damageable](damageable.md
| ----- | ----------- | ----------- | ---- |
| `damagedEvent` | [`Event`](event.md)<[`DamageableObject`](damageableobject.md) object, [`Damage`](damage.md) damage> | Fired when the object takes damage. | Server-Only |
| `diedEvent` | [`Event`](event.md)<[`DamageableObject`](damageableobject.md) object, [`Damage`](damage.md) damage> | Fired when the object dies. | Server-Only |
| `hitPointsChangedEvent` | [`Event`](event.md)<[`DamageableObject`](damageableobject.md) object, `number` previousHitPoints> | Fired when there's a change in hit points on the object. | Server-Only |

## Hooks

Expand Down
3 changes: 2 additions & 1 deletion src/api/physicsobject.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ A CoreObject with simulated physics that can interact with players and other obj
| ----- | ----------- | ----------- | ---- |
| `damagedEvent` | [`Event`](event.md)<[`PhysicsObject`](physicsobject.md) object, [`Damage`](damage.md) damage> | Fired when the object takes damage. | Server-Only |
| `diedEvent` | [`Event`](event.md)<[`PhysicsObject`](physicsobject.md) object, [`Damage`](damage.md) damage> | Fired when the object dies. | Server-Only |
| `collidedEvent` | [`Event`](event.md)<[`PhysicsObject`](physicsobject.md) object , [`HitResult`](hitresult.md) hitResult> | Fired when the object collides with another object. The `HitResult` parameter describes the collision that occurred. | None |
| `hitPointsChangedEvent` | [`Event`](event.md)<[`PhysicsObject`](physicsobject.md) object, `number` previousHitPoints> | Fired when there's a change in hit points on the object. | Server-Only |
| `collidedEvent` | [`Event`](event.md)<[`PhysicsObject`](physicsobject.md) object, [`HitResult`](hitresult.md) hitResult> | Fired when the object collides with another object. The `HitResult` parameter describes the collision that occurred. | None |

## Hooks

Expand Down
2 changes: 2 additions & 0 deletions src/api/player.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Player is an object representation of the state of a player connected to the gam
| `shouldFlipOnMultiJump` | `boolean` | Set to `false` to disable flip animation when player performs double-jump, triple-jump, etc. Defaults to `true`, enabling flip animation. | Read-Write |
| `jumpVelocity` | `number` | Vertical speed applied to Player when they jump. Default = 900. Speed is expressed in centimeters per second. | Read-Write |
| `gravityScale` | `number` | Multiplier on gravity applied. Default = 1.9. | Read-Write |
| `airControl` | `number` | When falling, amount of lateral movement control available to the player. 0 is no control. 1 is full control. Default = 0.5. | Read-Write |
| `maxMountSpeed` | `number` | Maximum speed while the player is mounted. Default = 1280. | Read-Write |
| `maxSwimSpeed` | `number` | Maximum speed while the player is swimming. Default = 420. | Read-Write |
| `maxFlySpeed` | `number` | Maximum speed while the player is flying. Default = 600. | Read-Write |
| `touchForceFactor` | `number` | Force applied to physics objects when contacted with a Player. Default = 1. | Read-Write |
Expand Down
1 change: 1 addition & 0 deletions src/api/vehicle.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Vehicle is a CoreObject representing a vehicle that can be occupied and driven b
| `driverExitedEvent` | [`Event`](event.md)<[`Vehicle`](vehicle.md) vehicle, [`Player`](player.md) player> | Fired when a driver exits the vehicle. | None |
| `damagedEvent` | [`Event`](event.md)<[`Vehicle`](vehicle.md) vehicle, [`Damage`](damage.md) damage> | Fired when the vehicle takes damage. | Server-Only |
| `diedEvent` | [`Event`](event.md)<[`Vehicle`](vehicle.md) vehicle, [`Damage`](damage.md) damage> | Fired when the vehicle dies. | Server-Only |
| `hitPointsChangedEvent` | [`Event`](event.md)<[`Vehicle`](vehicle.md) vehicle, `number` previousHitPoints> | Fired when there's a change in hit points on the vehicle. | Server-Only |

## Hooks

Expand Down

0 comments on commit 024ca44

Please sign in to comment.