Improve Documentation
All checks were successful
ScriptCraft/pipeline/head This commit looks good

This commit is contained in:
TheBrokenRail 2020-04-27 16:22:28 -04:00
parent 473b8c0ba3
commit afeea22abe
5 changed files with 16 additions and 4 deletions

View File

@ -158,7 +158,7 @@ export class Identifier {
/** /**
* Check Equality * Check Equality
* @param id Other Value * @param id Other Value
* @returns True If Equal * @returns TRUE If Equal, Otherwise FALSE
*/ */
equals(id: Identifier): boolean { equals(id: Identifier): boolean {
return id.getNamespace() === this.getNamespace() && id.getPath() === this.getPath(); return id.getNamespace() === this.getNamespace() && id.getPath() === this.getPath();
@ -271,7 +271,7 @@ export class Pos {
/** /**
* Check Equality * Check Equality
* @param id Other Value * @param id Other Value
* @returns True If Equal * @returns TRUE If Equal, Otherwise FALSE
*/ */
equals(pos: Pos): boolean { equals(pos: Pos): boolean {
return pos.getX() === this.getX() && pos.getY() === this.getY() && pos.getZ() === this.getZ(); return pos.getX() === this.getX() && pos.getY() === this.getY() && pos.getZ() === this.getZ();

View File

@ -1,3 +1,13 @@
/**
* API Entry-Point
*
* Import With:
* ```typescript
* import { ... } from 'minecraft';
* ```
* @packageDocumentation
*/
export { Identifier, ActionResult, Hand, Pos, Direction, DirectionUtil } from './core'; export { Identifier, ActionResult, Hand, Pos, Direction, DirectionUtil } from './core';
export { CustomBlock, CustomBlockEntity, CustomBlockWithEntity, BlockSettings, BlockState } from './block'; export { CustomBlock, CustomBlockEntity, CustomBlockWithEntity, BlockSettings, BlockState } from './block';
export { ItemStack, ItemSettings, CustomItem, BlockItem } from './item'; export { ItemStack, ItemSettings, CustomItem, BlockItem } from './item';

View File

@ -88,7 +88,7 @@ export class ItemStack {
/** /**
* Is Item Damageable * Is Item Damageable
* @returns True If Item Is Damageable * @returns TRUE If Item Is Damageable, Otherwise FALSE
*/ */
isDamageable(): boolean { isDamageable(): boolean {
return useBridge('ItemStack.isDamageable', this.javaObject) as boolean; return useBridge('ItemStack.isDamageable', this.javaObject) as boolean;

View File

@ -22,7 +22,7 @@ export class World {
* Set Block State * Set Block State
* @param pos Position * @param pos Position
* @param state Block State * @param state Block State
* @returns True If Successful * @returns TRUE If Successful, Otherwise FALSE
*/ */
setBlockState(pos: Pos, state: BlockState): boolean { setBlockState(pos: Pos, state: BlockState): boolean {
return useBridge('World.setBlockState', this.javaObject, pos.getX(), pos.getY(), pos.getZ(), state.javaObject) as boolean; return useBridge('World.setBlockState', this.javaObject, pos.getX(), pos.getY(), pos.getZ(), state.javaObject) as boolean;

View File

@ -1,7 +1,9 @@
{ {
"name": "ScriptCraft API",
"mode": "modules", "mode": "modules",
"readme": "none", "readme": "none",
"excludeNotExported": true, "excludeNotExported": true,
"excludePrivate": true, "excludePrivate": true,
"excludeExternals": true,
"stripInternal": true "stripInternal": true
} }