Skip to content

examples

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
@minecraft
@minecraft
 
 
types
types
 
 
README.md
README.md
 
 
clearCache.js
clearCache.js
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

The examples folder contains code snippets for usage of script API features, which they're featured in API references generated using TypeDoc within GitHub Pages when deployed.

File structure

  • reserved.json: A file that lists reserved file names for type definitions of Minecraft Bedrock Script APIs. Files created with reserved filenames will not be added to documentation.
  • Examples of class usage are located {ClassName}/constructor/* directory.
  • Examples of class static properties' usage are located in the {ClassName}/* directory.
  • Examples of class instance properties' usage are located in {ClassName}/prototype/* directory.
  • Examples usage of interface and enumeration are located in either the {InterfaceName}/* or {EnumName}/* directories.
  • Properties inherited from classes will not be documented. Please document the inherited properties in inherited class.