mirror of
				https://github.com/SquidDev-CC/CC-Tweaked
				synced 2025-11-04 07:32:59 +00:00 
			
		
		
		
	Compare commits
	
		
			190 Commits
		
	
	
		
			v1.12.2-1.
			...
			v1.94.0
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						 | 
					43408bf085 | ||
| 
						 | 
					d28f42e8b7 | ||
| 
						 | 
					ac452582c1 | ||
| 
						 | 
					7e65c6b25c | ||
| 
						 | 
					457a863842 | ||
| 
						 | 
					eef36e1358 | ||
| 
						 | 
					feda08b915 | ||
| 
						 | 
					0240ce50ce | ||
| 
						 | 
					592b83e784 | ||
| 
						 | 
					5d91491ec7 | ||
| 
						 | 
					7326d1110d | ||
| 
						 | 
					0aa6ac05a0 | ||
| 
						 | 
					27a2c063b9 | ||
| 
						 | 
					89a195ec06 | ||
| 
						 | 
					0e5fd4e8e0 | ||
| 
						 | 
					aa4ec53bb6 | ||
| 
						 | 
					6b49327462 | ||
| 
						 | 
					74ad934889 | ||
| 
						 | 
					08b3dbbad5 | ||
| 
						 | 
					54eac0a2f8 | ||
| 
						 | 
					51ca5e620c | ||
| 
						 | 
					076d572831 | ||
| 
						 | 
					75f2b91fef | ||
| 
						 | 
					79534e5630 | ||
| 
						 | 
					d483a91459 | ||
| 
						 | 
					71d764f122 | ||
| 
						 | 
					2e527eb11e | ||
| 
						 | 
					19273b3696 | ||
| 
						 | 
					4643641d51 | ||
| 
						 | 
					63cd9c5bc7 | ||
| 
						 | 
					e9c11ff325 | ||
| 
						 | 
					452464aa01 | ||
| 
						 | 
					8885462175 | ||
| 
						 | 
					b8bd64913b | ||
| 
						 | 
					88722d484f | ||
| 
						 | 
					6d103e2114 | ||
| 
						 | 
					42f23d56ae | ||
| 
						 | 
					89d5211bd7 | ||
| 
						 | 
					83e70377f7 | ||
| 
						 | 
					f6a26f75c3 | ||
| 
						 | 
					664df62d5d | ||
| 
						 | 
					1348ee0588 | ||
| 
						 | 
					145dce7653 | ||
| 
						 | 
					7f2651c23e | ||
| 
						 | 
					05464107a8 | ||
| 
						 | 
					86705787f0 | ||
| 
						 | 
					b34d8387d9 | ||
| 
						 | 
					4d00969ef0 | ||
| 
						 | 
					01d3d12992 | ||
| 
						 | 
					5e31dcde83 | ||
| 
						 | 
					5184883af1 | ||
| 
						 | 
					0c45112262 | ||
| 
						 | 
					0bf1672f45 | ||
| 
						 | 
					e1b8ac1f84 | ||
| 
						 | 
					deea552d99 | ||
| 
						 | 
					54229c2ce1 | ||
| 
						 | 
					1346a26179 | ||
| 
						 | 
					14df44f09d | ||
| 
						 | 
					1a21529499 | ||
| 
						 | 
					2546990f41 | ||
| 
						 | 
					b39ca02464 | ||
| 
						 | 
					628618105c | ||
| 
						 | 
					075ba03f5d | ||
| 
						 | 
					10bf84b631 | ||
| 
						 | 
					c346e22a45 | ||
| 
						 | 
					418e1335b1 | ||
| 
						 | 
					d52372df31 | ||
| 
						 | 
					cc72e1c2bd | ||
| 
						 | 
					d28afcc6a9 | ||
| 
						 | 
					220ed21e6e | ||
| 
						 | 
					09d465774d | ||
| 
						 | 
					dfc8f48f12 | ||
| 
						 | 
					abe2ec4686 | ||
| 
						 | 
					5333cda44e | ||
| 
						 | 
					dc88fbeb12 | ||
| 
						 | 
					c5eb7a9501 | ||
| 
						 | 
					bc969db2be | ||
| 
						 | 
					50b7646178 | ||
| 
						 | 
					3fa6b5bc9d | ||
| 
						 | 
					33e65e39e3 | ||
| 
						 | 
					0380e60590 | ||
| 
						 | 
					2918892ee2 | ||
| 
						 | 
					e43dd9f7c6 | ||
| 
						 | 
					244fd95034 | ||
| 
						 | 
					14e98e2fcb | ||
| 
						 | 
					dcf5d59109 | ||
| 
						 | 
					b95083c77e | ||
| 
						 | 
					c54c8c3ea6 | ||
| 
						 | 
					f79c67e243 | ||
| 
						 | 
					6ec7ebe439 | ||
| 
						 | 
					76fe33760d | ||
| 
						 | 
					cb549d8f43 | ||
| 
						 | 
					7b400fdcdd | ||
| 
						 | 
					ab70d918b5 | ||
| 
						 | 
					c64644b9ec | ||
| 
						 | 
					afb12eb342 | ||
| 
						 | 
					64f5ca02b3 | ||
| 
						 | 
					84bca21b0c | ||
| 
						 | 
					b6757c416f | ||
| 
						 | 
					dc9d3f2d15 | ||
| 
						 | 
					807825d74e | ||
| 
						 | 
					14c17676c6 | ||
| 
						 | 
					324519575c | ||
| 
						 | 
					fbcf26bdc9 | ||
| 
						 | 
					30ab6bd045 | ||
| 
						 | 
					2ea816b78b | ||
| 
						 | 
					56dcc57755 | ||
| 
						 | 
					a4830aff86 | ||
| 
						 | 
					621bc526be | ||
| 
						 | 
					605e1f6b9b | ||
| 
						 | 
					cb66ef7e30 | ||
| 
						 | 
					fd2f6a38c1 | ||
| 
						 | 
					229821d398 | ||
| 
						 | 
					1f2e0c444d | ||
| 
						 | 
					429baa350c | ||
| 
						 | 
					7fe62485fa | ||
| 
						 | 
					fe10c68099 | ||
| 
						 | 
					06092cfddd | ||
| 
						 | 
					9967dc5740 | ||
| 
						 | 
					b920e04c59 | ||
| 
						 | 
					baa1b5a5c9 | ||
| 
						 | 
					e84663a5c5 | ||
| 
						 | 
					1c46220c42 | ||
| 
						 | 
					889b445855 | ||
| 
						 | 
					19553a981e | ||
| 
						 | 
					15f4dbd061 | ||
| 
						 | 
					98e12c7c3e | ||
| 
						 | 
					dfad319864 | ||
| 
						 | 
					111b58f533 | ||
| 
						 | 
					9345652808 | ||
| 
						 | 
					d40163b409 | ||
| 
						 | 
					96400966d7 | ||
| 
						 | 
					db83bd4f64 | ||
| 
						 | 
					579a38d366 | ||
| 
						 | 
					0e6797c7da | ||
| 
						 | 
					c935577768 | ||
| 
						 | 
					c2b4077aa1 | ||
| 
						 | 
					ac020859f3 | ||
| 
						 | 
					238be8955b | ||
| 
						 | 
					f997b02b8f | ||
| 
						 | 
					799bb77847 | ||
| 
						 | 
					2f66792a0d | ||
| 
						 | 
					6cae8e211e | ||
| 
						 | 
					48b1b2f01d | ||
| 
						 | 
					8c45fd362a | ||
| 
						 | 
					07b13dd2b4 | ||
| 
						 | 
					45e84e1ede | ||
| 
						 | 
					b6715bd812 | ||
| 
						 | 
					725dfa764f | ||
| 
						 | 
					c221502ec9 | ||
| 
						 | 
					234f18c228 | ||
| 
						 | 
					006ad109cb | ||
| 
						 | 
					18aee02221 | ||
| 
						 | 
					401bbf2e6a | ||
| 
						 | 
					7467b7f88a | ||
| 
						 | 
					c82d8a7c2a | ||
| 
						 | 
					3d67421d98 | ||
| 
						 | 
					0db080154c | ||
| 
						 | 
					bb138326df | ||
| 
						 | 
					200311033f | ||
| 
						 | 
					3192dc81ac | ||
| 
						 | 
					b11d4bb209 | ||
| 
						 | 
					2a716244e9 | ||
| 
						 | 
					19b7ed538a | ||
| 
						 | 
					b0d9dc0b88 | ||
| 
						 | 
					e0660b1dab | ||
| 
						 | 
					2182cfbeb7 | ||
| 
						 | 
					e6094a59fa | ||
| 
						 | 
					e8d7e6a562 | ||
| 
						 | 
					536c2d9b2d | ||
| 
						 | 
					2c027adb68 | ||
| 
						 | 
					f15a278f3b | ||
| 
						 | 
					26b73c2ff3 | ||
| 
						 | 
					4a25e7a178 | ||
| 
						 | 
					55d54fec63 | ||
| 
						 | 
					220e4bd660 | ||
| 
						 | 
					c1e08fc3c7 | ||
| 
						 | 
					b9ec6f236d | ||
| 
						 | 
					b1fff97bff | ||
| 
						 | 
					c81bc70475 | ||
| 
						 | 
					362dbd97ac | ||
| 
						 | 
					aa0e1883d1 | ||
| 
						 | 
					9cdbcb4332 | ||
| 
						 | 
					23ddd4feb5 | ||
| 
						 | 
					fcaa777c95 | ||
| 
						 | 
					55a7ee4acf | ||
| 
						 | 
					7afc3e5260 | ||
| 
						 | 
					f9e13ca67a | ||
| 
						 | 
					810258e9b8 | ||
| 
						 | 
					5e462adc5c | 
@@ -11,12 +11,5 @@ insert_final_newline = true
 | 
			
		||||
[*.md]
 | 
			
		||||
trim_trailing_whitespace = false
 | 
			
		||||
 | 
			
		||||
[*.sexp]
 | 
			
		||||
indent_size = 2
 | 
			
		||||
 | 
			
		||||
[*.yml]
 | 
			
		||||
indent_size = 2
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
[*.properties]
 | 
			
		||||
insert_final_newline = false
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										75
									
								
								.github/workflows/main-ci.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										75
									
								
								.github/workflows/main-ci.yml
									
									
									
									
										vendored
									
									
								
							@@ -3,51 +3,48 @@ name: Build
 | 
			
		||||
on: [push, pull_request]
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  build:
 | 
			
		||||
    name: Build
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    build:
 | 
			
		||||
        name: Build
 | 
			
		||||
        runs-on: ubuntu-latest
 | 
			
		||||
 | 
			
		||||
    steps:
 | 
			
		||||
    - uses: actions/checkout@v1
 | 
			
		||||
        steps:
 | 
			
		||||
            - uses: actions/checkout@v2
 | 
			
		||||
 | 
			
		||||
    - name: Set up JDK 1.8
 | 
			
		||||
      uses: actions/setup-java@v1
 | 
			
		||||
      with:
 | 
			
		||||
        java-version: 1.8
 | 
			
		||||
            - name: Set up Java 8
 | 
			
		||||
              uses: actions/setup-java@v1
 | 
			
		||||
              with:
 | 
			
		||||
                  java-version: 8
 | 
			
		||||
 | 
			
		||||
    - name: Cache gradle dependencies
 | 
			
		||||
      uses: actions/cache@v1
 | 
			
		||||
      with:
 | 
			
		||||
        path: ~/.gradle/caches
 | 
			
		||||
        key: ${{ runner.os }}-gradle-${{ hashFiles('gradle.properties') }}
 | 
			
		||||
        restore-keys: |
 | 
			
		||||
          ${{ runner.os }}-gradle-
 | 
			
		||||
            - name: Cache gradle dependencies
 | 
			
		||||
              uses: actions/cache@v1
 | 
			
		||||
              with:
 | 
			
		||||
                  path: ~/.gradle/caches
 | 
			
		||||
                  key: ${{ runner.os }}-gradle-${{ hashFiles('gradle.properties') }}
 | 
			
		||||
                  restore-keys: |
 | 
			
		||||
                      ${{ runner.os }}-gradle-
 | 
			
		||||
 | 
			
		||||
    - name: Build with Gradle
 | 
			
		||||
      run: ./gradlew build --no-daemon
 | 
			
		||||
            - name: Build with Gradle
 | 
			
		||||
              run: ./gradlew build --no-daemon || ./gradlew build --no-daemon
 | 
			
		||||
 | 
			
		||||
    - name: Upload Jar
 | 
			
		||||
      uses: actions/upload-artifact@v1
 | 
			
		||||
      with:
 | 
			
		||||
        name: CC-Tweaked
 | 
			
		||||
        path: build/libs
 | 
			
		||||
            - name: Upload Jar
 | 
			
		||||
              uses: actions/upload-artifact@v1
 | 
			
		||||
              with:
 | 
			
		||||
                  name: CC-Tweaked
 | 
			
		||||
                  path: build/libs
 | 
			
		||||
 | 
			
		||||
    - name: Upload Coverage
 | 
			
		||||
      run: bash <(curl -s https://codecov.io/bash)
 | 
			
		||||
            - name: Upload Coverage
 | 
			
		||||
              run: bash <(curl -s https://codecov.io/bash)
 | 
			
		||||
              continue-on-error: true
 | 
			
		||||
 | 
			
		||||
  lint-lua:
 | 
			
		||||
    name: Lint Lua
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
            - name: Generate Java documentation stubs
 | 
			
		||||
              run: ./gradlew luaJavadoc --no-daemon
 | 
			
		||||
 | 
			
		||||
    steps:
 | 
			
		||||
    - uses: actions/checkout@v1
 | 
			
		||||
            - name: Lint Lua code
 | 
			
		||||
              run: |
 | 
			
		||||
                  test -d bin || mkdir bin
 | 
			
		||||
                  test -f bin/illuaminate || wget -q -Obin/illuaminate https://squiddev.cc/illuaminate/linux-x86-64/illuaminate
 | 
			
		||||
                  chmod +x bin/illuaminate
 | 
			
		||||
                  bin/illuaminate lint
 | 
			
		||||
 | 
			
		||||
    - name: Lint Lua code
 | 
			
		||||
      run: |
 | 
			
		||||
        test -d bin || mkdir bin
 | 
			
		||||
        test -f bin/illuaminate || wget -q -Obin/illuaminate https://squiddev.cc/illuaminate/linux-x86-64/illuaminate
 | 
			
		||||
        chmod +x bin/illuaminate
 | 
			
		||||
        bin/illuaminate lint
 | 
			
		||||
 | 
			
		||||
    - name: Check whitespace
 | 
			
		||||
      run: python3 tools/check-lines.py
 | 
			
		||||
            - name: Check whitespace
 | 
			
		||||
              run: python3 tools/check-lines.py
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										16
									
								
								.github/workflows/make-doc.sh
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										16
									
								
								.github/workflows/make-doc.sh
									
									
									
									
										vendored
									
									
								
							@@ -1,16 +0,0 @@
 | 
			
		||||
#!/usr/bin/env bash
 | 
			
		||||
 | 
			
		||||
set -eu
 | 
			
		||||
 | 
			
		||||
DEST="${GITHUB_REF#refs/*/}"
 | 
			
		||||
echo "Uploading docs to https://tweaked.cc/$DEST"
 | 
			
		||||
 | 
			
		||||
# Setup ssh key
 | 
			
		||||
mkdir -p "$HOME/.ssh/"
 | 
			
		||||
echo "$SSH_KEY" > "$HOME/.ssh/key"
 | 
			
		||||
chmod 600 "$HOME/.ssh/key"
 | 
			
		||||
 | 
			
		||||
# And upload
 | 
			
		||||
rsync -avc -e "ssh -i $HOME/.ssh/key -o StrictHostKeyChecking=no -p $SSH_PORT" \
 | 
			
		||||
      "$GITHUB_WORKSPACE/doc/" \
 | 
			
		||||
      "$SSH_USER@$SSH_HOST:/var/www/tweaked.cc/$DEST"
 | 
			
		||||
							
								
								
									
										29
									
								
								.github/workflows/make-doc.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										29
									
								
								.github/workflows/make-doc.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,29 +0,0 @@
 | 
			
		||||
name: Build documentation
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches: [ master ]
 | 
			
		||||
    tags:
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  make_doc:
 | 
			
		||||
    name: Build
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
 | 
			
		||||
    steps:
 | 
			
		||||
    - uses: actions/checkout@v1
 | 
			
		||||
 | 
			
		||||
    - name: Build documentation
 | 
			
		||||
      run: |
 | 
			
		||||
        test -d bin || mkdir bin
 | 
			
		||||
        test -f bin/illuaminate || wget -q -Obin/illuaminate https://squiddev.cc/illuaminate/linux-x86-64/illuaminate
 | 
			
		||||
        chmod +x bin/illuaminate
 | 
			
		||||
        bin/illuaminate doc-gen
 | 
			
		||||
 | 
			
		||||
    - name: Upload documentation
 | 
			
		||||
      run: .github/workflows/make-doc.sh 2> /dev/null
 | 
			
		||||
      env:
 | 
			
		||||
        SSH_KEY:  ${{ secrets.SSH_KEY  }}
 | 
			
		||||
        SSH_USER: ${{ secrets.SSH_USER }}
 | 
			
		||||
        SSH_HOST: ${{ secrets.SSH_HOST }}
 | 
			
		||||
        SSH_PORT: ${{ secrets.SSH_PORT }}
 | 
			
		||||
							
								
								
									
										7
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										7
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							@@ -3,8 +3,6 @@
 | 
			
		||||
/logs
 | 
			
		||||
/build
 | 
			
		||||
/out
 | 
			
		||||
/doc/**/*.html
 | 
			
		||||
/doc/index.json
 | 
			
		||||
 | 
			
		||||
# Runtime directories
 | 
			
		||||
/run
 | 
			
		||||
@@ -17,9 +15,4 @@
 | 
			
		||||
.idea
 | 
			
		||||
.gradle
 | 
			
		||||
*.DS_Store
 | 
			
		||||
 | 
			
		||||
.classpath
 | 
			
		||||
.project
 | 
			
		||||
.settings/
 | 
			
		||||
bin/
 | 
			
		||||
*.launch
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										34
									
								
								.luacheckrc
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								.luacheckrc
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,34 @@
 | 
			
		||||
std = "max"
 | 
			
		||||
 | 
			
		||||
ignore = {
 | 
			
		||||
    -- Allow access to undefined globals or their fields. In the future we'll
 | 
			
		||||
    -- define all of CC's globals within this file
 | 
			
		||||
    '113', '143',
 | 
			
		||||
 | 
			
		||||
    -- FIXME: Ignore unused arguments and loop variables
 | 
			
		||||
    '212', '213',
 | 
			
		||||
 | 
			
		||||
    -- Disable line is too long for now. It would be possible to clean
 | 
			
		||||
    -- this up in the future.
 | 
			
		||||
    '631',
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
-- Only run the linter on ROM and bios for now, as the treasure disks
 | 
			
		||||
-- are largely unsupported.
 | 
			
		||||
include_files = {
 | 
			
		||||
    'src/main/resources/assets/computercraft/lua/rom',
 | 
			
		||||
    'src/main/resources/assets/computercraft/lua/bios.lua'
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
files['src/main/resources/assets/computercraft/lua/bios.lua'] = {
 | 
			
		||||
    -- Allow declaring and mutating globals
 | 
			
		||||
    allow_defined_top = true,
 | 
			
		||||
    ignore = { '112', '121', '122', '131', '142' },
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
files['src/main/resources/assets/computercraft/lua/rom/apis'] = {
 | 
			
		||||
    -- APIs may define globals on the top level. We'll ignore unused globals,
 | 
			
		||||
    -- as obviously they may be used outside that API.
 | 
			
		||||
    allow_defined_top = true,
 | 
			
		||||
    ignore = { '131' },
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										14
									
								
								.travis.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										14
									
								
								.travis.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,14 @@
 | 
			
		||||
language: java
 | 
			
		||||
 | 
			
		||||
script: ./gradlew build --no-daemon
 | 
			
		||||
 | 
			
		||||
before_cache:
 | 
			
		||||
  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
 | 
			
		||||
  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
 | 
			
		||||
cache:
 | 
			
		||||
  directories:
 | 
			
		||||
    - $HOME/.gradle/caches/
 | 
			
		||||
    - $HOME/.gradle/wrapper/s
 | 
			
		||||
 | 
			
		||||
jdk:
 | 
			
		||||
    - oraclejdk8
 | 
			
		||||
							
								
								
									
										3
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,3 @@
 | 
			
		||||
{
 | 
			
		||||
	"java.configuration.updateBuildConfiguration": "automatic"
 | 
			
		||||
}
 | 
			
		||||
@@ -1,36 +0,0 @@
 | 
			
		||||
# Contributing to CC: Tweaked
 | 
			
		||||
As with many open source projects, CC: Tweaked thrives on contributions from other people! This document (hopefully)
 | 
			
		||||
provides an introduction as to how to get started in helping out.
 | 
			
		||||
 | 
			
		||||
If you've any other questions, [just ask the community][community] or [open an issue][new-issue].
 | 
			
		||||
 | 
			
		||||
## Reporting issues
 | 
			
		||||
If you have a bug, suggestion, or other feedback, the best thing to do is [file an issue][new-issue]. When doing so,
 | 
			
		||||
do use the issue templates - they provide a useful hint on what information to provide.
 | 
			
		||||
 | 
			
		||||
## Developing
 | 
			
		||||
In order to develop CC: Tweaked, you'll need to download the source code and then run it. This is a pretty simple
 | 
			
		||||
process.
 | 
			
		||||
 | 
			
		||||
 - **Clone the repository:** `git clone https://github.com/SquidDev-CC/CC-Tweaked.git && cd CC-Tweaked`
 | 
			
		||||
 - **Setup Forge:** `./gradlew setupDecompWorkspace`
 | 
			
		||||
 - **Run Minecraft:** `./gradlew runClient` (or run the `GradleStart` class from your IDE).
 | 
			
		||||
 | 
			
		||||
If you want to run CC:T in a normal Minecraft instance, run `./gradlew build` and copy the `.jar` from `build/libs`.
 | 
			
		||||
These commands may take a few minutes to run the first time, as the environment is set up, but should be much faster
 | 
			
		||||
afterwards.
 | 
			
		||||
 | 
			
		||||
### Code linters
 | 
			
		||||
CC: Tweaked uses a couple of "linters" on its source code, to enforce a consistent style across the project. While these
 | 
			
		||||
are run whenever you submit a PR, it's often useful to run this before committing.
 | 
			
		||||
 | 
			
		||||
 - **[Checkstyle]:** Checks Java code to ensure it is consistently formatted. This can be run with `./gradlew build` or
 | 
			
		||||
   `./gradle check`.
 | 
			
		||||
 - **[illuaminate]:** Checks Lua code for semantic and styleistic issues. See [the usage section][illuaminate-usage] for
 | 
			
		||||
   how to download and run it.
 | 
			
		||||
 | 
			
		||||
[new-issue]: https://github.com/SquidDev-CC/CC-Tweaked/issues/new/choose "Create a new issue"
 | 
			
		||||
[community]: README.md#Community "Get in touch with the community."
 | 
			
		||||
[checkstyle]: https://checkstyle.org/
 | 
			
		||||
[illuaminate]: https://github.com/SquidDev/illuaminate/
 | 
			
		||||
[illuaminate-usage]: https://github.com/SquidDev/illuaminate/blob/master/README.md#usage
 | 
			
		||||
							
								
								
									
										72
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										72
									
								
								README.md
									
									
									
									
									
								
							@@ -1,69 +1,9 @@
 | 
			
		||||
# 
 | 
			
		||||
[](https://github.com/SquidDev-CC/CC-Tweaked/actions "Current build status") [](https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked on CurseForge")
 | 
			
		||||
# CC:Restitched Patchwork
 | 
			
		||||
# This is a Work In Progress Port
 | 
			
		||||
*it runs and works-ish*
 | 
			
		||||
 | 
			
		||||
CC: Tweaked is a fork of [ComputerCraft](https://github.com/dan200/ComputerCraft), adding programmable computers,
 | 
			
		||||
turtles and more to Minecraft.
 | 
			
		||||
## Reached Parity with CC:T 1.94.0
 | 
			
		||||
 | 
			
		||||
## What?
 | 
			
		||||
ComputerCraft has always held a fond place in my heart: it's the mod which really got me into Minecraft, and it's the
 | 
			
		||||
mod which has kept me playing it for many years. However, development of the original mod has slowed, as the original
 | 
			
		||||
developers have had less time to work on the mod, and moved onto other projects and commitments.
 | 
			
		||||
THis is just a quick patchwork of my attempts at getting CC:R up to date with CC:T
 | 
			
		||||
 | 
			
		||||
CC: Tweaked (or CC:T for short) is an attempt to continue ComputerCraft's legacy. It's not intended to be a competitor
 | 
			
		||||
to CC, nor do I want to take it in a vastly different direction to the original mod. Instead, CC:T focuses on making the
 | 
			
		||||
ComputerCraft experience as _solid_ as possible, ironing out any wrinkles that may have developed over time.
 | 
			
		||||
 | 
			
		||||
## Features
 | 
			
		||||
CC: Tweaked contains all the features of the latest version of ComputerCraft, as well as numerous fixes, performance
 | 
			
		||||
improvements and several nifty additions. I'd recommend checking out [the releases page](https://github.com/SquidDev-CC/CC-Tweaked/releases)
 | 
			
		||||
to see the full set of changes, but here's a couple of the more interesting additions:
 | 
			
		||||
 | 
			
		||||
 - Improvements to the `http` library, including websockets, support for other HTTP methods (`PUT`, `DELETE`, etc...)
 | 
			
		||||
   and configurable limits on HTTP usage.
 | 
			
		||||
 - Full-block wired modems, allowing one to wrap non-solid peripherals (such as turtles, or chests if Plethora is
 | 
			
		||||
   installed).
 | 
			
		||||
 - Pocket computers can be held like maps, allowing you to view the screen without entering a GUI.
 | 
			
		||||
 - Printed pages and books can be placed in item frames and held like maps.
 | 
			
		||||
 - Several profiling and administration tools for server owners, via the `/computercraft` command. This allows operators
 | 
			
		||||
   to track which computers are hogging resources, turn on and shutdown multiple computers at once and interact with
 | 
			
		||||
   computers remotely.
 | 
			
		||||
 - Closer emulation of standard Lua, adding the `debug` and `io` libraries. This also enables seeking within binary
 | 
			
		||||
   files, meaning you don't need to read large files into memory.
 | 
			
		||||
 - Allow running multiple computers on multiple threads, reducing latency on worlds with many computers.
 | 
			
		||||
 | 
			
		||||
## Relation to CCTweaks?
 | 
			
		||||
This mod has nothing to do with CCTweaks, though there is no denying the name is a throwback to it. That being said,
 | 
			
		||||
several features have been included, such as full block modems, the Cobalt runtime and map-like rendering for pocket
 | 
			
		||||
computers.
 | 
			
		||||
 | 
			
		||||
## Contributing
 | 
			
		||||
Any contribution is welcome, be that using the mod, reporting bugs or contributing code. If you want to get started
 | 
			
		||||
developing the mod, [check out the instructions here](CONTRIBUTING.md#developing).
 | 
			
		||||
 | 
			
		||||
## Community
 | 
			
		||||
If you need help getting started with CC: Tweaked, want to show off your latest project, or just want to chat about
 | 
			
		||||
ComputerCraft we have a [forum](https://forums.computercraft.cc/) and [Discord guild](https://discord.computercraft.cc)!
 | 
			
		||||
There's also a fairly populated, albeit quiet [IRC channel](http://webchat.esper.net/?channels=computercraft), if that's
 | 
			
		||||
more your cup of tea.
 | 
			
		||||
 | 
			
		||||
I'd generally recommend you don't contact me directly (email, DM, etc...) unless absolutely necessary (i.e. in order to
 | 
			
		||||
report exploits). You'll get a far quicker response if you ask the whole community!
 | 
			
		||||
 | 
			
		||||
## Using
 | 
			
		||||
If you want to depend on CC: Tweaked, we have a maven repo. However, you should be wary that some functionality is only
 | 
			
		||||
exposed by CC:T's API and not vanilla ComputerCraft. If you wish to support all variations of ComputerCraft, I recommend
 | 
			
		||||
using [cc.crzd.me's maven](https://cc.crzd.me/maven/) instead.
 | 
			
		||||
 | 
			
		||||
```groovy
 | 
			
		||||
dependencies {
 | 
			
		||||
  maven { url 'https://squiddev.cc/maven/' }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
dependencies {
 | 
			
		||||
  implementation "org.squiddev:cc-tweaked-${mc_version}:${cct_version}"
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
You should also be careful to only use classes within the `dan200.computercraft.api` package. Non-API classes are
 | 
			
		||||
subject to change at any point. If you depend on functionality outside the API, file an issue, and we can look into
 | 
			
		||||
exposing more features.
 | 
			
		||||
The changelog is located at [PatchWork.md](patchwork.md)
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										471
									
								
								build.gradle
									
									
									
									
									
								
							
							
						
						
									
										471
									
								
								build.gradle
									
									
									
									
									
								
							@@ -1,439 +1,120 @@
 | 
			
		||||
 | 
			
		||||
// For those who want the bleeding edge
 | 
			
		||||
buildscript {
 | 
			
		||||
    repositories {
 | 
			
		||||
        jcenter()
 | 
			
		||||
        maven {
 | 
			
		||||
            name = "forge"
 | 
			
		||||
            url = "https://files.minecraftforge.net/maven"
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
    dependencies {
 | 
			
		||||
        classpath 'com.google.code.gson:gson:2.8.1'
 | 
			
		||||
        classpath 'net.minecraftforge.gradle:ForgeGradle:2.3-SNAPSHOT'
 | 
			
		||||
        classpath 'net.sf.proguard:proguard-gradle:6.1.0beta1'
 | 
			
		||||
        classpath 'org.ajoberstar.grgit:grgit-gradle:3.0.0'
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
plugins {
 | 
			
		||||
    id "checkstyle"
 | 
			
		||||
    id "jacoco"
 | 
			
		||||
    id "com.github.hierynomus.license" version "0.15.0"
 | 
			
		||||
    id "com.matthewprenger.cursegradle" version "1.3.0"
 | 
			
		||||
    id "com.github.breadmoirai.github-release" version "2.2.4"
 | 
			
		||||
    id 'fabric-loom' version '0.5-SNAPSHOT'
 | 
			
		||||
    id 'maven-publish'
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
apply plugin: 'net.minecraftforge.gradle.forge'
 | 
			
		||||
apply plugin: 'org.ajoberstar.grgit'
 | 
			
		||||
apply plugin: 'maven-publish'
 | 
			
		||||
apply plugin: 'maven'
 | 
			
		||||
sourceCompatibility = JavaVersion.VERSION_1_8
 | 
			
		||||
targetCompatibility = JavaVersion.VERSION_1_8
 | 
			
		||||
 | 
			
		||||
version = mod_version
 | 
			
		||||
 | 
			
		||||
group = "org.squiddev"
 | 
			
		||||
archivesBaseName = "cc-tweaked-${mc_version}"
 | 
			
		||||
 | 
			
		||||
minecraft {
 | 
			
		||||
    version = "${mc_version}-${forge_version}"
 | 
			
		||||
    runDir = "run"
 | 
			
		||||
    replace '${version}', mod_version
 | 
			
		||||
 | 
			
		||||
    mappings = mappings_version
 | 
			
		||||
    makeObfSourceJar = false
 | 
			
		||||
}
 | 
			
		||||
group = "dan200.computercraft"
 | 
			
		||||
archivesBaseName = "cc-tweaked-fabric-${mc_version}"
 | 
			
		||||
 | 
			
		||||
repositories {
 | 
			
		||||
    mavenCentral()
 | 
			
		||||
    maven {
 | 
			
		||||
        name "SquidDev"
 | 
			
		||||
        url "https://squiddev.cc/maven"
 | 
			
		||||
    }
 | 
			
		||||
    ivy {
 | 
			
		||||
        name "Charset"
 | 
			
		||||
        artifactPattern "https://asie.pl/files/mods/Charset/LibOnly/[module]-[revision](-[classifier]).[ext]"
 | 
			
		||||
    }
 | 
			
		||||
    maven {
 | 
			
		||||
        name "Amadornes"
 | 
			
		||||
        url "https://maven.amadornes.com/"
 | 
			
		||||
    }
 | 
			
		||||
    maven {
 | 
			
		||||
        name "CraftTweaker"
 | 
			
		||||
        url "https://maven.blamejared.com/"
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
configurations {
 | 
			
		||||
    shade
 | 
			
		||||
    compile.extendsFrom shade
 | 
			
		||||
    deployerJars
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
dependencies {
 | 
			
		||||
    checkstyle "com.puppycrawl.tools:checkstyle:8.25"
 | 
			
		||||
    minecraft "com.mojang:minecraft:${mc_version}"
 | 
			
		||||
    mappings "net.fabricmc:yarn:${mc_version}+build.${mappings_version}:v2"
 | 
			
		||||
    modImplementation "net.fabricmc:fabric-loader:${fabric_loader_version}"
 | 
			
		||||
    modImplementation "net.fabricmc.fabric-api:fabric-api:${fabric_api_version}"
 | 
			
		||||
 | 
			
		||||
    deobfProvided "CraftTweaker2:CraftTweaker2-MC1120-Main:1.12-4.1.20.554"
 | 
			
		||||
    deobfProvided "MCMultiPart2:MCMultiPart:2.5.3"
 | 
			
		||||
    deobfProvided "mezz.jei:jei_1.12.2:4.15.0.269:api"
 | 
			
		||||
    deobfProvided "pl.asie:Charset-Lib:0.5.4.6"
 | 
			
		||||
    modImplementation "me.shedaniel.cloth:config-2:${cloth_config_version}"
 | 
			
		||||
    modImplementation "io.github.prospector:modmenu:${modmenu_version}"
 | 
			
		||||
 | 
			
		||||
    runtime "mezz.jei:jei_1.12.2:4.15.0.269"
 | 
			
		||||
    modApi "me.shedaniel.cloth.api:cloth-utils-v1:${project.cloth_api_version}"
 | 
			
		||||
    include "me.shedaniel.cloth.api:cloth-utils-v1:${project.cloth_api_version}"
 | 
			
		||||
 | 
			
		||||
    implementation "blue.endless:jankson:${jankson_version}"
 | 
			
		||||
    implementation 'com.google.code.findbugs:jsr305:3.0.2'
 | 
			
		||||
 | 
			
		||||
    compileOnly 'com.google.auto.service:auto-service:1.0-rc7'
 | 
			
		||||
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc7'
 | 
			
		||||
 | 
			
		||||
    include "me.shedaniel.cloth:config-2:${cloth_config_version}"
 | 
			
		||||
    include "blue.endless:jankson:${jankson_version}"
 | 
			
		||||
    include 'javax.vecmath:vecmath:1.5.2'
 | 
			
		||||
 | 
			
		||||
    compile 'javax.vecmath:vecmath:1.5.2'
 | 
			
		||||
 | 
			
		||||
    shade 'org.squiddev:Cobalt:0.5.1-SNAPSHOT'
 | 
			
		||||
 | 
			
		||||
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.4.2'
 | 
			
		||||
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.4.2'
 | 
			
		||||
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.1.0'
 | 
			
		||||
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.1.0'
 | 
			
		||||
 | 
			
		||||
    deployerJars "org.apache.maven.wagon:wagon-ssh:3.0.0"
 | 
			
		||||
    modRuntime "me.shedaniel:RoughlyEnoughItems-api:5.2.10"
 | 
			
		||||
    modRuntime "me.shedaniel:RoughlyEnoughItems:5.2.10"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Compile tasks
 | 
			
		||||
sourceSets {
 | 
			
		||||
    main {
 | 
			
		||||
        java {
 | 
			
		||||
            exclude 'dan200/computercraft/shared/integration'
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
javadoc {
 | 
			
		||||
    include "dan200/computercraft/api/**/*.java"
 | 
			
		||||
processResources {
 | 
			
		||||
    inputs.property "version", project.version
 | 
			
		||||
 | 
			
		||||
    from(sourceSets.main.resources.srcDirs) {
 | 
			
		||||
        include "fabric.mod.json"
 | 
			
		||||
        expand "version": project.version
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    from(sourceSets.main.resources.srcDirs) {
 | 
			
		||||
        exclude "fabric.mod.json"
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ensure that the encoding is set to UTF-8, no matter what the system default is
 | 
			
		||||
// this fixes some edge cases with special characters not displaying correctly
 | 
			
		||||
// see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html
 | 
			
		||||
tasks.withType(JavaCompile) {
 | 
			
		||||
    options.encoding = "UTF-8"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task
 | 
			
		||||
// if it is present.
 | 
			
		||||
// If you remove this task, sources will not be generated.
 | 
			
		||||
task sourcesJar(type: Jar, dependsOn: classes) {
 | 
			
		||||
    classifier = "sources"
 | 
			
		||||
    from sourceSets.main.allSource
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
jar {
 | 
			
		||||
    dependsOn javadoc
 | 
			
		||||
 | 
			
		||||
    manifest {
 | 
			
		||||
        attributes('FMLAT': 'computercraft_at.cfg')
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    from (sourceSets.main.allSource) {
 | 
			
		||||
        include "dan200/computercraft/api/**/*.java"
 | 
			
		||||
    }
 | 
			
		||||
    from "LICENSE"
 | 
			
		||||
 | 
			
		||||
    from configurations.shade.collect { it.isDirectory() ? it : zipTree(it) }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
[compileJava, compileTestJava].forEach {
 | 
			
		||||
    it.configure {
 | 
			
		||||
        options.compilerArgs << "-Xlint" << "-Xlint:-processing" << "-Werror"
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
import java.nio.charset.StandardCharsets
 | 
			
		||||
import java.nio.file.*
 | 
			
		||||
import java.util.zip.*
 | 
			
		||||
 | 
			
		||||
import com.google.gson.GsonBuilder
 | 
			
		||||
import com.google.gson.JsonElement
 | 
			
		||||
import com.hierynomus.gradle.license.tasks.LicenseCheck
 | 
			
		||||
import com.hierynomus.gradle.license.tasks.LicenseFormat
 | 
			
		||||
import org.ajoberstar.grgit.Grgit
 | 
			
		||||
import proguard.gradle.ProGuardTask
 | 
			
		||||
 | 
			
		||||
task proguard(type: ProGuardTask, dependsOn: jar) {
 | 
			
		||||
    description "Removes unused shadowed classes from the jar"
 | 
			
		||||
    group "compact"
 | 
			
		||||
 | 
			
		||||
    injars jar.archivePath
 | 
			
		||||
    outjars "${jar.archivePath.absolutePath.replace(".jar", "")}-min.jar"
 | 
			
		||||
 | 
			
		||||
    // Add the main runtime jar and all non-shadowed dependencies
 | 
			
		||||
    libraryjars "${System.getProperty('java.home')}/lib/rt.jar"
 | 
			
		||||
    libraryjars "${System.getProperty('java.home')}/lib/jce.jar"
 | 
			
		||||
    doFirst {
 | 
			
		||||
        sourceSets.main.compileClasspath
 | 
			
		||||
            .filter { !it.name.contains("Cobalt") }
 | 
			
		||||
            .each { libraryjars it }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // We want to avoid as much obfuscation as possible. We're only doing this to shrink code size.
 | 
			
		||||
    dontobfuscate; dontoptimize; keepattributes; keepparameternames
 | 
			
		||||
 | 
			
		||||
    // Proguard will remove directories by default, but that breaks JarMount.
 | 
			
		||||
    keepdirectories 'assets/computercraft/lua**'
 | 
			
		||||
 | 
			
		||||
    // Preserve ComputerCraft classes - we only want to strip shadowed files.
 | 
			
		||||
    keep 'class dan200.computercraft.** { *; }'
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
task proguardMove(dependsOn: proguard) {
 | 
			
		||||
    description "Replace the original jar with the minified version"
 | 
			
		||||
    group "compact"
 | 
			
		||||
 | 
			
		||||
    doLast {
 | 
			
		||||
        Files.move(
 | 
			
		||||
            file("${jar.archivePath.absolutePath.replace(".jar", "")}-min.jar").toPath(),
 | 
			
		||||
            file(jar.archivePath).toPath(),
 | 
			
		||||
            StandardCopyOption.REPLACE_EXISTING
 | 
			
		||||
        )
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
reobfJar.dependsOn proguardMove
 | 
			
		||||
 | 
			
		||||
processResources {
 | 
			
		||||
    inputs.property "version", mod_version
 | 
			
		||||
    inputs.property "mcversion", mc_version
 | 
			
		||||
 | 
			
		||||
    def hash = 'none'
 | 
			
		||||
    Set<String> contributors = []
 | 
			
		||||
    try {
 | 
			
		||||
        def grgit = Grgit.open(dir: '.')
 | 
			
		||||
        hash = grgit.head().id
 | 
			
		||||
 | 
			
		||||
        def blacklist = ['GitHub', 'dan200', 'Daniel Ratcliffe']
 | 
			
		||||
        grgit.log().each {
 | 
			
		||||
            if (!blacklist.contains(it.author.name)) contributors.add(it.author.name)
 | 
			
		||||
            if (!blacklist.contains(it.committer.name)) contributors.add(it.committer.name)
 | 
			
		||||
        }
 | 
			
		||||
    } catch(Exception ignored) { }
 | 
			
		||||
 | 
			
		||||
    inputs.property "commithash", hash
 | 
			
		||||
 | 
			
		||||
    from(sourceSets.main.resources.srcDirs) {
 | 
			
		||||
        include 'mcmod.info'
 | 
			
		||||
        include 'assets/computercraft/lua/rom/help/credits.txt'
 | 
			
		||||
 | 
			
		||||
        expand 'version': mod_version,
 | 
			
		||||
               'mcversion': mc_version,
 | 
			
		||||
               'gitcontributors': contributors.sort(false, String.CASE_INSENSITIVE_ORDER).join('\n')
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    from(sourceSets.main.resources.srcDirs) {
 | 
			
		||||
        exclude 'mcmod.info'
 | 
			
		||||
        exclude 'assets/computercraft/lua/rom/help/credits.txt'
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
task compressJson(dependsOn: extractAnnotationsJar) {
 | 
			
		||||
    group "compact"
 | 
			
		||||
    description "Minifies all JSON files, stripping whitespace"
 | 
			
		||||
 | 
			
		||||
    def jarPath = file(jar.archivePath)
 | 
			
		||||
 | 
			
		||||
    def tempPath = File.createTempFile("input", ".jar", temporaryDir)
 | 
			
		||||
    tempPath.deleteOnExit()
 | 
			
		||||
 | 
			
		||||
    def gson = new GsonBuilder().create()
 | 
			
		||||
 | 
			
		||||
    doLast {
 | 
			
		||||
        // Copy over all files in the current jar to the new one, running json files from GSON. As pretty printing
 | 
			
		||||
        // is turned off, they should be minified.
 | 
			
		||||
        new ZipFile(jarPath).withCloseable { inJar ->
 | 
			
		||||
            tempPath.getParentFile().mkdirs()
 | 
			
		||||
            new ZipOutputStream(new BufferedOutputStream(new FileOutputStream(tempPath))).withCloseable { outJar ->
 | 
			
		||||
                inJar.entries().each { entry ->
 | 
			
		||||
                    if(entry.directory) {
 | 
			
		||||
                        outJar.putNextEntry(entry)
 | 
			
		||||
                    } else if(!entry.name.endsWith(".json")) {
 | 
			
		||||
                        outJar.putNextEntry(entry)
 | 
			
		||||
                        inJar.getInputStream(entry).withCloseable { outJar << it }
 | 
			
		||||
                    } else {
 | 
			
		||||
                        ZipEntry newEntry = new ZipEntry(entry.name)
 | 
			
		||||
                        newEntry.setTime(entry.time)
 | 
			
		||||
                        outJar.putNextEntry(newEntry)
 | 
			
		||||
 | 
			
		||||
                        def element = inJar.getInputStream(entry).withCloseable { gson.fromJson(it.newReader("UTF8"), JsonElement.class) }
 | 
			
		||||
                        outJar.write(gson.toJson(element).getBytes(StandardCharsets.UTF_8))
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // And replace the original jar again
 | 
			
		||||
        Files.move(tempPath.toPath(), jarPath.toPath(), StandardCopyOption.REPLACE_EXISTING)
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
assemble.dependsOn compressJson
 | 
			
		||||
 | 
			
		||||
// Check tasks
 | 
			
		||||
 | 
			
		||||
test {
 | 
			
		||||
    useJUnitPlatform()
 | 
			
		||||
    testLogging {
 | 
			
		||||
        events "skipped", "failed"
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
jacocoTestReport {
 | 
			
		||||
    reports {
 | 
			
		||||
        xml.enabled true
 | 
			
		||||
        html.enabled true
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
check.dependsOn jacocoTestReport
 | 
			
		||||
 | 
			
		||||
license {
 | 
			
		||||
    mapping("java", "SLASHSTAR_STYLE")
 | 
			
		||||
    strictCheck true
 | 
			
		||||
 | 
			
		||||
    ext.year = Calendar.getInstance().get(Calendar.YEAR)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
[licenseMain, licenseFormatMain].forEach {
 | 
			
		||||
    it.configure {
 | 
			
		||||
        include("**/*.java")
 | 
			
		||||
        exclude("dan200/computercraft/api/**")
 | 
			
		||||
        header rootProject.file('config/license/main.txt')
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
[licenseTest, licenseFormatTest].forEach {
 | 
			
		||||
    it.configure {
 | 
			
		||||
        include("**/*.java")
 | 
			
		||||
        header rootProject.file('config/license/main.txt')
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
gradle.projectsEvaluated {
 | 
			
		||||
    tasks.withType(LicenseFormat) {
 | 
			
		||||
        outputs.upToDateWhen { false }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
task licenseAPI(type: LicenseCheck);
 | 
			
		||||
task licenseFormatAPI(type: LicenseFormat);
 | 
			
		||||
[licenseAPI, licenseFormatAPI].forEach {
 | 
			
		||||
    it.configure {
 | 
			
		||||
        source = sourceSets.main.java
 | 
			
		||||
        include("dan200/computercraft/api/**")
 | 
			
		||||
        header rootProject.file('config/license/api.txt')
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Upload tasks
 | 
			
		||||
 | 
			
		||||
task checkRelease {
 | 
			
		||||
    group "upload"
 | 
			
		||||
    description "Verifies that everything is ready for a release"
 | 
			
		||||
 | 
			
		||||
    inputs.property "version", mod_version
 | 
			
		||||
    inputs.file("src/main/resources/assets/computercraft/lua/rom/help/changelog.txt")
 | 
			
		||||
    inputs.file("src/main/resources/assets/computercraft/lua/rom/help/whatsnew.txt")
 | 
			
		||||
 | 
			
		||||
    doLast {
 | 
			
		||||
        def ok = true
 | 
			
		||||
 | 
			
		||||
        // Check we're targetting the current version
 | 
			
		||||
        def whatsnew = new File("src/main/resources/assets/computercraft/lua/rom/help/whatsnew.txt").readLines()
 | 
			
		||||
        if (whatsnew[0] != "New features in CC: Tweaked $mod_version") {
 | 
			
		||||
            ok = false
 | 
			
		||||
            project.logger.error("Expected `whatsnew.txt' to target $mod_version.")
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Check "read more" exists and trim it
 | 
			
		||||
        def idx = whatsnew.findIndexOf { it == 'Type "help changelog" to see the full version history.' }
 | 
			
		||||
        if (idx == -1) {
 | 
			
		||||
            ok = false
 | 
			
		||||
            project.logger.error("Must mention the changelog in whatsnew.txt")
 | 
			
		||||
        } else {
 | 
			
		||||
            whatsnew = whatsnew.getAt(0 ..< idx)
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Check whatsnew and changelog match.
 | 
			
		||||
        def versionChangelog = "# " + whatsnew.join("\n")
 | 
			
		||||
        def changelog = new File("src/main/resources/assets/computercraft/lua/rom/help/changelog.txt").getText()
 | 
			
		||||
        if (!changelog.startsWith(versionChangelog)) {
 | 
			
		||||
            ok = false
 | 
			
		||||
            project.logger.error("whatsnew and changelog are not in sync")
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (!ok) throw new IllegalStateException("Could not check release")
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
check.dependsOn checkRelease
 | 
			
		||||
 | 
			
		||||
curseforge {
 | 
			
		||||
    apiKey = project.hasProperty('curseForgeApiKey') ? project.curseForgeApiKey : ''
 | 
			
		||||
    project {
 | 
			
		||||
        id = '282001'
 | 
			
		||||
        releaseType = 'release'
 | 
			
		||||
        changelog = "Release notes can be found on the GitHub repository (https://github.com/SquidDev-CC/CC-Tweaked/releases/tag/v${mc_version}-${mod_version})."
 | 
			
		||||
 | 
			
		||||
        relations {
 | 
			
		||||
            incompatible "computercraft"
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// configure the maven publication
 | 
			
		||||
publishing {
 | 
			
		||||
    publications {
 | 
			
		||||
        mavenJava(MavenPublication) {
 | 
			
		||||
            from components.java
 | 
			
		||||
            artifact sourceJar
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uploadArchives {
 | 
			
		||||
    repositories {
 | 
			
		||||
        if(project.hasProperty('mavenUploadUrl')) {
 | 
			
		||||
            mavenDeployer {
 | 
			
		||||
                configuration = configurations.deployerJars
 | 
			
		||||
 | 
			
		||||
                repository(url: project.property('mavenUploadUrl')) {
 | 
			
		||||
                    authentication(
 | 
			
		||||
                        userName: project.property('mavenUploadUser'),
 | 
			
		||||
                        privateKey: project.property('mavenUploadKey'))
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                pom.project {
 | 
			
		||||
                    name 'CC: Tweaked'
 | 
			
		||||
                    packaging 'jar'
 | 
			
		||||
                    description 'CC: Tweaked is a fork of ComputerCraft, adding programmable computers, turtles and more to Minecraft.'
 | 
			
		||||
                    url 'https://github.com/SquidDev-CC/CC-Tweaked'
 | 
			
		||||
 | 
			
		||||
                    scm {
 | 
			
		||||
                        url 'https://github.com/SquidDev-CC/CC-Tweaked.git'
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    issueManagement {
 | 
			
		||||
                        system 'github'
 | 
			
		||||
                        url 'https://github.com/SquidDev-CC/CC-Tweaked/issues'
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    licenses {
 | 
			
		||||
                        license {
 | 
			
		||||
                            name 'ComputerCraft Public License, Version 1.0'
 | 
			
		||||
                            url 'https://github.com/SquidDev-CC/CC-Tweaked/blob/master/LICENSE'
 | 
			
		||||
                            distribution 'repo'
 | 
			
		||||
                        }
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                pom.whenConfigured { pom ->
 | 
			
		||||
                    pom.dependencies.clear()
 | 
			
		||||
                }
 | 
			
		||||
            // add all the jars that should be included when publishing to maven
 | 
			
		||||
            artifact(remapJar) {
 | 
			
		||||
                builtBy remapJar
 | 
			
		||||
            }
 | 
			
		||||
            artifact(sourcesJar) {
 | 
			
		||||
                builtBy remapSourcesJar
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
githubRelease {
 | 
			
		||||
    token project.hasProperty('githubApiKey') ? project.githubApiKey : ''
 | 
			
		||||
    owner 'SquidDev-CC'
 | 
			
		||||
    repo 'CC-Tweaked'
 | 
			
		||||
    try {
 | 
			
		||||
        targetCommitish = Grgit.open(dir: '.').branch.current().name
 | 
			
		||||
    } catch(Exception ignored) { }
 | 
			
		||||
 | 
			
		||||
    tagName "v${mc_version}-${mod_version}"
 | 
			
		||||
    releaseName "[${mc_version}] ${mod_version}"
 | 
			
		||||
    body {
 | 
			
		||||
        "## " + new File("src/main/resources/assets/computercraft/lua/rom/help/whatsnew.txt")
 | 
			
		||||
            .readLines()
 | 
			
		||||
            .takeWhile { it != 'Type "help changelog" to see the full version history.' }
 | 
			
		||||
            .join("\n").trim()
 | 
			
		||||
    // select the repositories you want to publish to
 | 
			
		||||
    repositories {
 | 
			
		||||
        // uncomment to publish to the local maven
 | 
			
		||||
        // mavenLocal()
 | 
			
		||||
    }
 | 
			
		||||
    prerelease false
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
def uploadTasks = ["uploadArchives", "curseforge", "githubRelease"]
 | 
			
		||||
uploadTasks.forEach { tasks.getByName(it).dependsOn checkRelease }
 | 
			
		||||
 | 
			
		||||
task uploadAll(dependsOn: uploadTasks) {
 | 
			
		||||
    group "upload"
 | 
			
		||||
    description "Uploads to all repositories (Maven, Curse, GitHub release)"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
runClient.outputs.upToDateWhen { false }
 | 
			
		||||
runServer.outputs.upToDateWhen { false }
 | 
			
		||||
 
 | 
			
		||||
@@ -1,169 +0,0 @@
 | 
			
		||||
<?xml version="1.0" encoding="UTF-8"?>
 | 
			
		||||
<!DOCTYPE module PUBLIC
 | 
			
		||||
    "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
 | 
			
		||||
    "https://checkstyle.org/dtds/configuration_1_3.dtd">
 | 
			
		||||
<module name="Checker">
 | 
			
		||||
    <property name="tabWidth" value="4"/>
 | 
			
		||||
    <property name="charset" value="UTF-8" />
 | 
			
		||||
 | 
			
		||||
    <module name="SuppressionFilter">
 | 
			
		||||
        <property name="file" value="config/checkstyle/suppressions.xml" />
 | 
			
		||||
    </module>
 | 
			
		||||
 | 
			
		||||
    <module name="TreeWalker">
 | 
			
		||||
        <!-- Annotations -->
 | 
			
		||||
        <module name="AnnotationLocation" />
 | 
			
		||||
        <module name="AnnotationUseStyle" />
 | 
			
		||||
        <module name="MissingDeprecated" />
 | 
			
		||||
        <module name="MissingOverride" />
 | 
			
		||||
 | 
			
		||||
        <!-- Blocks -->
 | 
			
		||||
        <module name="EmptyBlock" />
 | 
			
		||||
        <module name="EmptyCatchBlock">
 | 
			
		||||
            <property name="exceptionVariableName" value="ignored" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="LeftCurly">
 | 
			
		||||
            <property name="option" value="nl" />
 | 
			
		||||
            <!-- The defaults, minus lambdas. -->
 | 
			
		||||
            <property name="tokens" value="ANNOTATION_DEF,CLASS_DEF,CTOR_DEF,ENUM_CONSTANT_DEF,ENUM_DEF,INTERFACE_DEF,LITERAL_CASE,LITERAL_CATCH,LITERAL_DEFAULT,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_SWITCH,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE,METHOD_DEF,OBJBLOCK,STATIC_INIT" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="NeedBraces">
 | 
			
		||||
            <property name="allowSingleLineStatement" value="true"/>
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="RightCurly">
 | 
			
		||||
            <property name="option" value="alone" />
 | 
			
		||||
        </module>
 | 
			
		||||
 | 
			
		||||
        <!-- Class design. As if we've ever followed good practice here. -->
 | 
			
		||||
        <module name="FinalClass" />
 | 
			
		||||
        <module name="InterfaceIsType" />
 | 
			
		||||
        <module name="MutableException" />
 | 
			
		||||
        <module name="OneTopLevelClass" />
 | 
			
		||||
 | 
			
		||||
        <!-- Coding -->
 | 
			
		||||
        <module name="ArrayTrailingComma" />
 | 
			
		||||
        <module name="EqualsHashCode" />
 | 
			
		||||
        <!-- FallThrough does not handle unreachable code well -->
 | 
			
		||||
        <module name="IllegalInstantiation" />
 | 
			
		||||
        <module name="IllegalThrows" />
 | 
			
		||||
        <module name="ModifiedControlVariable" />
 | 
			
		||||
        <module name="NoClone" />
 | 
			
		||||
        <module name="NoFinalizer" />
 | 
			
		||||
        <module name="OneStatementPerLine" />
 | 
			
		||||
        <module name="PackageDeclaration" />
 | 
			
		||||
        <module name="SimplifyBooleanExpression" />
 | 
			
		||||
        <module name="SimplifyBooleanReturn" />
 | 
			
		||||
        <module name="StringLiteralEquality" />
 | 
			
		||||
        <module name="UnnecessaryParentheses" />
 | 
			
		||||
        <module name="UnnecessarySemicolonAfterTypeMemberDeclaration" />
 | 
			
		||||
        <module name="UnnecessarySemicolonInTryWithResources" />
 | 
			
		||||
        <module name="UnnecessarySemicolonInEnumeration" />
 | 
			
		||||
 | 
			
		||||
        <!-- Imports -->
 | 
			
		||||
        <module name="CustomImportOrder" />
 | 
			
		||||
        <module name="IllegalImport" />
 | 
			
		||||
        <module name="RedundantImport" />
 | 
			
		||||
        <module name="UnusedImports" />
 | 
			
		||||
 | 
			
		||||
        <!-- Javadoc -->
 | 
			
		||||
        <!-- TODO: Missing* checks for the dan200.computercraft.api package? -->
 | 
			
		||||
        <module name="AtclauseOrder" />
 | 
			
		||||
        <module name="InvalidJavadocPosition" />
 | 
			
		||||
        <module name="JavadocBlockTagLocation" />
 | 
			
		||||
        <module name="JavadocMethod"/>
 | 
			
		||||
        <module name="JavadocType"/>
 | 
			
		||||
        <module name="JavadocStyle" />
 | 
			
		||||
        <module name="NonEmptyAtclauseDescription" />
 | 
			
		||||
        <module name="SingleLineJavadoc" />
 | 
			
		||||
        <module name="SummaryJavadocCheck"/>
 | 
			
		||||
 | 
			
		||||
        <!-- Misc -->
 | 
			
		||||
        <module name="ArrayTypeStyle" />
 | 
			
		||||
        <module name="CommentsIndentation" />
 | 
			
		||||
        <module name="Indentation" />
 | 
			
		||||
        <module name="OuterTypeFilename" />
 | 
			
		||||
 | 
			
		||||
        <!-- Modifiers -->
 | 
			
		||||
        <module name="ModifierOrder" />
 | 
			
		||||
        <module name="RedundantModifier" />
 | 
			
		||||
 | 
			
		||||
        <!-- Naming -->
 | 
			
		||||
        <module name="ClassTypeParameterName" />
 | 
			
		||||
        <module name="InterfaceTypeParameterName" />
 | 
			
		||||
        <module name="LambdaParameterName" />
 | 
			
		||||
        <module name="LocalFinalVariableName" />
 | 
			
		||||
        <module name="LocalVariableName" />
 | 
			
		||||
        <!-- Allow an optional m_ on private members -->
 | 
			
		||||
        <module name="MemberName">
 | 
			
		||||
            <property name="applyToPrivate" value="false" />
 | 
			
		||||
            <property name="applyToPackage" value="false" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="MemberName">
 | 
			
		||||
            <property name="format" value="^(m_)?[a-z][a-zA-Z0-9]*$" />
 | 
			
		||||
            <property name="applyToPrivate" value="true" />
 | 
			
		||||
            <property name="applyToPackage" value="true" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="MethodName" />
 | 
			
		||||
        <module name="MethodTypeParameterName" />
 | 
			
		||||
        <module name="PackageName">
 | 
			
		||||
            <property name="format" value="^dan200\.computercraf(\.[a-z][a-z0-9]*)*" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="ParameterName" />
 | 
			
		||||
        <module name="StaticVariableName">
 | 
			
		||||
            <property name="format" value="^[a-z][a-zA-Z0-9]*|CAPABILITY(_[A-Z]+)?$" />
 | 
			
		||||
            <property name="applyToPrivate" value="false" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="StaticVariableName">
 | 
			
		||||
            <property name="format" value="^(s_)?[a-z][a-zA-Z0-9]*|CAPABILITY(_[A-Z]+)?$" />
 | 
			
		||||
            <property name="applyToPrivate" value="true" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="TypeName" />
 | 
			
		||||
 | 
			
		||||
        <!-- Whitespace -->
 | 
			
		||||
        <module name="EmptyForInitializerPad"/>
 | 
			
		||||
        <module name="EmptyForIteratorPad">
 | 
			
		||||
            <property name="option" value="space"/>
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="GenericWhitespace" />
 | 
			
		||||
        <module name="MethodParamPad" />
 | 
			
		||||
        <module name="NoLineWrap" />
 | 
			
		||||
        <module name="NoWhitespaceAfter">
 | 
			
		||||
            <property name="tokens" value="AT,INC,DEC,UNARY_MINUS,UNARY_PLUS,BNOT,LNOT,DOT,ARRAY_DECLARATOR,INDEX_OP" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="NoWhitespaceBefore" />
 | 
			
		||||
        <!-- TODO: Decide on an OperatorWrap style. -->
 | 
			
		||||
        <module name="ParenPad">
 | 
			
		||||
            <property name="option" value="space" />
 | 
			
		||||
            <property name="tokens" value="ANNOTATION,ANNOTATION_FIELD_DEF,CTOR_CALL,CTOR_DEF,ENUM_CONSTANT_DEF,LITERAL_CATCH,LITERAL_DO,LITERAL_FOR,LITERAL_IF,LITERAL_NEW,LITERAL_SWITCH,LITERAL_SYNCHRONIZED,LITERAL_WHILE,METHOD_CALL,METHOD_DEF,RESOURCE_SPECIFICATION,SUPER_CTOR_CALL,LAMBDA" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="ParenPad">
 | 
			
		||||
            <property name="option" value="nospace" />
 | 
			
		||||
            <property name="tokens" value="DOT,EXPR,QUESTION" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="SeparatorWrap">
 | 
			
		||||
            <property name="option" value="eol" />
 | 
			
		||||
            <property name="tokens" value="COMMA,SEMI,ELLIPSIS,ARRAY_DECLARATOR,RBRACK,METHOD_REF" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="SeparatorWrap">
 | 
			
		||||
            <property name="option" value="nl" />
 | 
			
		||||
            <property name="tokens" value="DOT,AT" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="SingleSpaceSeparator" />
 | 
			
		||||
        <module name="TypecastParenPad" />
 | 
			
		||||
        <module name="WhitespaceAfter">
 | 
			
		||||
            <property name="tokens" value="COMMA" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="WhitespaceAround">
 | 
			
		||||
            <property name="allowEmptyConstructors" value="true" />
 | 
			
		||||
            <property name="ignoreEnhancedForColon" value="false" />
 | 
			
		||||
            <property name="tokens" value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV,DIV_ASSIGN,DO_WHILE,EQUAL,GE,GT,LAMBDA,LAND,LCURLY,LE,LITERAL_RETURN,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,LITERAL_ASSERT,TYPE_EXTENSION_AND" />
 | 
			
		||||
        </module>
 | 
			
		||||
    </module>
 | 
			
		||||
 | 
			
		||||
    <module name="FileTabCharacter" />
 | 
			
		||||
    <module name="NewlineAtEndOfFile" />
 | 
			
		||||
    <module name="RegexpSingleline">
 | 
			
		||||
        <property name="format" value="\s+$"/>
 | 
			
		||||
        <property name="message" value="Trailing whitespace"/>
 | 
			
		||||
    </module>
 | 
			
		||||
</module>
 | 
			
		||||
@@ -1,12 +0,0 @@
 | 
			
		||||
<?xml version="1.0" encoding="UTF-8"?>
 | 
			
		||||
<!DOCTYPE suppressions PUBLIC
 | 
			
		||||
    "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
 | 
			
		||||
    "https://checkstyle.org/dtds/suppressions_1_2.dtd">
 | 
			
		||||
<suppressions>
 | 
			
		||||
    <!-- All the config options and method fields. -->
 | 
			
		||||
    <suppress checks="StaticVariableName" files=".*[\\/]ComputerCraft.java" />
 | 
			
		||||
    <suppress checks="StaticVariableName" files=".*[\\/]ComputerCraftAPI.java" />
 | 
			
		||||
 | 
			
		||||
    <!-- Do not check for missing package Javadoc. -->
 | 
			
		||||
    <suppress checks="JavadocStyle" files=".*[\\/]package-info.java" />
 | 
			
		||||
</suppressions>
 | 
			
		||||
@@ -1,3 +0,0 @@
 | 
			
		||||
This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
Copyright Daniel Ratcliffe, 2011-${year}. This API may be redistributed unmodified and in full only.
 | 
			
		||||
For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
@@ -1,3 +0,0 @@
 | 
			
		||||
This file is part of ComputerCraft - http://www.computercraft.info
 | 
			
		||||
Copyright Daniel Ratcliffe, 2011-${year}. Do not distribute without permission.
 | 
			
		||||
Send enquiries to dratcliffe@gmail.com
 | 
			
		||||
							
								
								
									
										11
									
								
								doc/index.md
									
									
									
									
									
								
							
							
						
						
									
										11
									
								
								doc/index.md
									
									
									
									
									
								
							@@ -1,11 +0,0 @@
 | 
			
		||||
#  [](https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked on CurseForge")
 | 
			
		||||
 | 
			
		||||
CC: Tweaked is a fork of [ComputerCraft], adding programmable computers, turtles and more to Minecraft.
 | 
			
		||||
 | 
			
		||||
This website contains documentation for all Lua libraries and APIs from the latest version of CC: Tweaked. This
 | 
			
		||||
documentation is still in development, so will most likely be incomplete. If you've found something you think is wrong,
 | 
			
		||||
or would like to help out [please get in touch on GitHub][gh].
 | 
			
		||||
 | 
			
		||||
[bug]: https://github.com/SquidDev-CC/CC-Tweaked/issues/new/choose
 | 
			
		||||
[computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub"
 | 
			
		||||
[gh]: https://github.com/SquidDev-CC/CC-Tweaked "CC:Tweaked on GitHub"
 | 
			
		||||
@@ -1,77 +0,0 @@
 | 
			
		||||
--- Execute a specific command.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string command The command to execute.
 | 
			
		||||
-- @treturn boolean Whether the command executed successfully.
 | 
			
		||||
-- @treturn { string... } The output of this command, as a list of lines.
 | 
			
		||||
-- @treturn number|nil The number of "affected" objects, or `nil` if the command
 | 
			
		||||
-- failed. The definition of this varies from command to command.
 | 
			
		||||
-- @usage Set the block above the command computer to stone.
 | 
			
		||||
--
 | 
			
		||||
--     commands.exec("setblock ~ ~1 ~ minecraft:stone")
 | 
			
		||||
function exec(command) end
 | 
			
		||||
 | 
			
		||||
--- Asynchronously execute a command.
 | 
			
		||||
--
 | 
			
		||||
-- Unlike @{exec}, this will immediately return, instead of waiting for the
 | 
			
		||||
-- command to execute. This allows you to run multiple commands at the same
 | 
			
		||||
-- time.
 | 
			
		||||
--
 | 
			
		||||
-- When this command has finished executing, it will queue a `task_complete`
 | 
			
		||||
-- event containing the result of executing this command (what @{exec} would
 | 
			
		||||
-- return).
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string command The command to execute.
 | 
			
		||||
-- @treturn number The "task id". When this command has been executed, it will
 | 
			
		||||
-- queue a `task_complete` event with a matching id.
 | 
			
		||||
-- @usage Asynchronously sets the block above the computer to stone.
 | 
			
		||||
--
 | 
			
		||||
--     commands.execAsync("~ ~1 ~ minecraft:stone")
 | 
			
		||||
-- @see parallel One may also use the parallel API to run multiple commands at
 | 
			
		||||
-- once.
 | 
			
		||||
function execAsync(commad) end
 | 
			
		||||
 | 
			
		||||
--- List all available commands which the computer has permission to execute.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn { string... } A list of all available commands
 | 
			
		||||
function list() end
 | 
			
		||||
 | 
			
		||||
--- Get the position of the current command computer.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn number This computer's x position.
 | 
			
		||||
-- @treturn number This computer's y position.
 | 
			
		||||
-- @treturn number This computer's z position.
 | 
			
		||||
-- @see gps.locate To get the position of a non-command computer.
 | 
			
		||||
function getBlockPosition() end
 | 
			
		||||
 | 
			
		||||
--- Get some basic information about a block.
 | 
			
		||||
--
 | 
			
		||||
-- The returned table contains the current name, metadata and block state (as
 | 
			
		||||
-- with @{turtle.inspect}). If there is a tile entity for that block, its NBT
 | 
			
		||||
-- will also be returned.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam number x The x position of the block to query.
 | 
			
		||||
-- @tparam number y The y position of the block to query.
 | 
			
		||||
-- @tparam number z The z position of the block to query.
 | 
			
		||||
-- @treturn table The given block's information.
 | 
			
		||||
-- @throws If the coordinates are not within the world, or are not currently
 | 
			
		||||
-- loaded.
 | 
			
		||||
function getBlockInfo(x, y, z) end
 | 
			
		||||
 | 
			
		||||
--- Get information about a range of blocks.
 | 
			
		||||
--
 | 
			
		||||
-- This returns the same information as @{getBlockInfo}, just for multiple
 | 
			
		||||
-- blocks at once.
 | 
			
		||||
--
 | 
			
		||||
-- Blocks are traversed by ascending y level, followed by z and x - the returned
 | 
			
		||||
-- table may be indexed using `x + z*width + y*depth*depth`.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam number min_x The start x coordinate of the range to query.
 | 
			
		||||
-- @tparam number min_y The start y coordinate of the range to query.
 | 
			
		||||
-- @tparam number min_z The start z coordinate of the range to query.
 | 
			
		||||
-- @tparam number max_x The end x coordinate of the range to query.
 | 
			
		||||
-- @tparam number max_y The end y coordinate of the range to query.
 | 
			
		||||
-- @tparam number max_z The end z coordinate of the range to query.
 | 
			
		||||
-- @treturn { table... } A list of information about each block.
 | 
			
		||||
-- @throws If the coordinates are not within the world.
 | 
			
		||||
-- @throws If trying to get information about more than 4096 blocks.
 | 
			
		||||
function getBlockInfos(min_x, min_y, min_z, max_x, max_y, max_z) end
 | 
			
		||||
@@ -1,84 +0,0 @@
 | 
			
		||||
---  The FS API allows you to manipulate files and the filesystem.
 | 
			
		||||
--
 | 
			
		||||
-- @module fs
 | 
			
		||||
 | 
			
		||||
function list(path) end
 | 
			
		||||
function combine(base, child) end
 | 
			
		||||
function getName(path) end
 | 
			
		||||
function getSize(path) end
 | 
			
		||||
function exists(path) end
 | 
			
		||||
function isDir(path) end
 | 
			
		||||
function isReadOnly(path) end
 | 
			
		||||
function makeDir(path) end
 | 
			
		||||
function move(from, to) end
 | 
			
		||||
function copy(from, to) end
 | 
			
		||||
function delete(path) end
 | 
			
		||||
function open(path, mode) end
 | 
			
		||||
function getDrive(path) end
 | 
			
		||||
function getFreeSpace(path) end
 | 
			
		||||
function find(pattern) end
 | 
			
		||||
function getDir(path) end
 | 
			
		||||
 | 
			
		||||
--- Returns true if a path is mounted to the parent filesystem.
 | 
			
		||||
--
 | 
			
		||||
-- The root filesystem "/" is considered a mount, along with disk folders and
 | 
			
		||||
-- the rom folder. Other programs (such as network shares) can exstend this to
 | 
			
		||||
-- make other mount types by correctly assigning their return value for getDrive.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string path The path to check.
 | 
			
		||||
-- @treturn boolean If the path is mounted, rather than a normal file/folder.
 | 
			
		||||
-- @throws If the path does not exist.
 | 
			
		||||
-- @see getDrive
 | 
			
		||||
function isDriveRoot(path) end
 | 
			
		||||
 | 
			
		||||
--- Get the capacity of the drive at the given path.
 | 
			
		||||
--
 | 
			
		||||
-- This may be used in conjunction with @{getFreeSpace} to determine what
 | 
			
		||||
-- percentage of this drive has been used.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string path The path of the drive to get.
 | 
			
		||||
-- @treturn number This drive's capacity. This will be 0 for "read-only" drives,
 | 
			
		||||
-- such as the ROM or treasure disks.
 | 
			
		||||
function getCapacity(path) end
 | 
			
		||||
 | 
			
		||||
--- Get attributes about a specific file or folder.
 | 
			
		||||
--
 | 
			
		||||
-- The returned attributes table contains information about the size of the
 | 
			
		||||
-- file, whether it is a directory, and when it was created and last modified.
 | 
			
		||||
--
 | 
			
		||||
-- The creation and modification times are given as the number of milliseconds
 | 
			
		||||
-- since the UNIX epoch. This may be given to @{os.date} in order to convert it
 | 
			
		||||
-- to more usable form.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string path The path to get attributes for.
 | 
			
		||||
-- @treturn { size = number, isDir = boolean, created = number, modified = number }
 | 
			
		||||
-- The resulting attributes.
 | 
			
		||||
-- @throws If the path does not exist.
 | 
			
		||||
-- @see getSize If you only care about the file's size.
 | 
			
		||||
-- @see isDir If you only care whether a path is a directory or not.
 | 
			
		||||
function attributes(path) end
 | 
			
		||||
 | 
			
		||||
-- Defined in bios.lua
 | 
			
		||||
function complete(sPath, sLocation, bIncludeFiles, bIncludeDirs) end
 | 
			
		||||
 | 
			
		||||
--- A file handle which can be read from.
 | 
			
		||||
--
 | 
			
		||||
-- @type ReadHandle
 | 
			
		||||
-- @see fs.open
 | 
			
		||||
local ReadHandle = {}
 | 
			
		||||
function ReadHandle.read(count) end
 | 
			
		||||
function ReadHandle.readAll() end
 | 
			
		||||
function ReadHandle.readLine(with_trailing) end
 | 
			
		||||
function ReadHandle.seek(whence, offset) end
 | 
			
		||||
function ReadHandle.close() end
 | 
			
		||||
 | 
			
		||||
--- A file handle which can be written to.
 | 
			
		||||
--
 | 
			
		||||
-- @type WriteHandle
 | 
			
		||||
-- @see fs.open
 | 
			
		||||
local WriteHandle = {}
 | 
			
		||||
function WriteHandle.write(text) end
 | 
			
		||||
function WriteHandle.writeLine(text) end
 | 
			
		||||
function WriteHandle.flush(text) end
 | 
			
		||||
function WriteHandle.seek(whence, offset) end
 | 
			
		||||
function WriteHandle.close() end
 | 
			
		||||
@@ -1,229 +0,0 @@
 | 
			
		||||
--- The http library allows communicating with web servers, sending and
 | 
			
		||||
-- receiving data from them.
 | 
			
		||||
--
 | 
			
		||||
-- #### `http_check` event
 | 
			
		||||
--
 | 
			
		||||
-- @module http
 | 
			
		||||
 | 
			
		||||
--- Asynchronously make a HTTP request to the given url.
 | 
			
		||||
--
 | 
			
		||||
-- This returns immediately, a [`http_success`](#http-success-event) or
 | 
			
		||||
-- [`http_failure`](#http-failure-event) will be queued once the request has
 | 
			
		||||
-- completed.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam      string url   The url to request
 | 
			
		||||
-- @tparam[opt] string body  An optional string containing the body of the
 | 
			
		||||
-- request. If specified, a `POST` request will be made instead.
 | 
			
		||||
-- @tparam[opt] { [string] = string } headers Additional headers to send as part
 | 
			
		||||
-- of this request.
 | 
			
		||||
-- @tparam[opt] boolean binary Whether to make a binary HTTP request. If true,
 | 
			
		||||
-- the body will not be UTF-8 encoded, and the received response will not be
 | 
			
		||||
-- decoded.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[2] {
 | 
			
		||||
--   url = string, body? = string, headers? = { [string] = string },
 | 
			
		||||
--   binary? = boolean, method? = string, redirect? = boolean,
 | 
			
		||||
-- } request Options for the request.
 | 
			
		||||
--
 | 
			
		||||
-- This table form is an expanded version of the previous syntax. All arguments
 | 
			
		||||
-- from above are passed in as fields instead (for instance,
 | 
			
		||||
-- `http.request("https://example.com")` becomes `http.request { url =
 | 
			
		||||
-- "https://example.com" }`).
 | 
			
		||||
--
 | 
			
		||||
-- This table also accepts several additional options:
 | 
			
		||||
--
 | 
			
		||||
--  - `method`: Which HTTP method to use, for instance `"PATCH"` or `"DELETE"`.
 | 
			
		||||
--  - `redirect`: Whether to follow HTTP redirects. Defaults to true.
 | 
			
		||||
--
 | 
			
		||||
-- @see http.get  For a synchronous way to make GET requests.
 | 
			
		||||
-- @see http.post For a synchronous way to make POST requests.
 | 
			
		||||
function request(...) end
 | 
			
		||||
 | 
			
		||||
--- Make a HTTP GET request to the given url.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string url   The url to request
 | 
			
		||||
-- @tparam[opt] { [string] = string } headers Additional headers to send as part
 | 
			
		||||
-- of this request.
 | 
			
		||||
-- @tparam[opt] boolean binary Whether to make a binary HTTP request. If true,
 | 
			
		||||
-- the body will not be UTF-8 encoded, and the received response will not be
 | 
			
		||||
-- decoded.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[2] {
 | 
			
		||||
--   url = string, headers? = { [string] = string },
 | 
			
		||||
--   binary? = boolean, method? = string, redirect? = boolean,
 | 
			
		||||
-- } request Options for the request. See @{http.request} for details on how
 | 
			
		||||
-- these options behave.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn Response The resulting http response, which can be read from.
 | 
			
		||||
-- @treturn[2] nil When the http request failed, such as in the event of a 404
 | 
			
		||||
-- error or connection timeout.
 | 
			
		||||
-- @treturn string A message detailing why the request failed.
 | 
			
		||||
-- @treturn Response|nil The failing http response, if available.
 | 
			
		||||
--
 | 
			
		||||
-- @usage Make a request to [example.computercraft.cc](https://example.computercraft.cc),
 | 
			
		||||
-- and print the returned page.
 | 
			
		||||
-- ```lua
 | 
			
		||||
-- local request = http.get("https://example.computercraft.cc")
 | 
			
		||||
-- print(request.readAll())
 | 
			
		||||
-- -- => HTTP is working!
 | 
			
		||||
-- request.close()
 | 
			
		||||
-- ```
 | 
			
		||||
function get(...) end
 | 
			
		||||
 | 
			
		||||
--- Make a HTTP POST request to the given url.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string url   The url to request
 | 
			
		||||
-- @tparam string body  The body of the POST request.
 | 
			
		||||
-- @tparam[opt] { [string] = string } headers Additional headers to send as part
 | 
			
		||||
-- of this request.
 | 
			
		||||
-- @tparam[opt] boolean binary Whether to make a binary HTTP request. If true,
 | 
			
		||||
-- the body will not be UTF-8 encoded, and the received response will not be
 | 
			
		||||
-- decoded.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[2] {
 | 
			
		||||
--   url = string, body? = string, headers? = { [string] = string },
 | 
			
		||||
--   binary? = boolean, method? = string, redirect? = boolean,
 | 
			
		||||
-- } request Options for the request. See @{http.request} for details on how
 | 
			
		||||
-- these options behave.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn Response The resulting http response, which can be read from.
 | 
			
		||||
-- @treturn[2] nil When the http request failed, such as in the event of a 404
 | 
			
		||||
-- error or connection timeout.
 | 
			
		||||
-- @treturn string A message detailing why the request failed.
 | 
			
		||||
-- @treturn Response|nil The failing http response, if available.
 | 
			
		||||
function post(...) end
 | 
			
		||||
 | 
			
		||||
--- A http response. This acts very much like a @{fs.ReadHandle|file}, though
 | 
			
		||||
-- provides some http specific methods.
 | 
			
		||||
--
 | 
			
		||||
-- #### `http_success` event
 | 
			
		||||
-- #### `http_failure` event
 | 
			
		||||
--
 | 
			
		||||
-- @type Response
 | 
			
		||||
-- @see http.request On how to make a http request.
 | 
			
		||||
local Response = {}
 | 
			
		||||
 | 
			
		||||
--- Returns the response code and response message returned by the server
 | 
			
		||||
--
 | 
			
		||||
-- @treturn number The response code (i.e. 200)
 | 
			
		||||
-- @treturn string The response message (i.e. "OK")
 | 
			
		||||
function Response.getResponseCode() end
 | 
			
		||||
 | 
			
		||||
--- Get a table containing the response's headers, in a format similar to that
 | 
			
		||||
-- required by @{http.request}. If multiple headers are sent with the same
 | 
			
		||||
-- name, they will be combined with a comma.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn { [string]=string } The response's headers.
 | 
			
		||||
-- Make a request to [example.computercraft.cc](https://example.computercraft.cc),
 | 
			
		||||
-- and print the returned headers.
 | 
			
		||||
-- ```lua
 | 
			
		||||
-- local request = http.get("https://example.computercraft.cc")
 | 
			
		||||
-- print(textutils.serialize(request.getResponseHeaders()))
 | 
			
		||||
-- -- => {
 | 
			
		||||
-- --   [ "Content-Type" ] = "text/plain; charset=utf8",
 | 
			
		||||
-- --   [ "content-length" ] = 17,
 | 
			
		||||
-- --   ...
 | 
			
		||||
-- -- }
 | 
			
		||||
-- request.close()
 | 
			
		||||
-- ```
 | 
			
		||||
function Response.getResponseHeaders() end
 | 
			
		||||
 | 
			
		||||
function Response.read(count) end
 | 
			
		||||
function Response.readAll() end
 | 
			
		||||
function Response.readLine(with_trailing) end
 | 
			
		||||
function Response.seek(whence, offset) end
 | 
			
		||||
function Response.close() end
 | 
			
		||||
 | 
			
		||||
--- Asynchronously determine whether a URL can be requested.
 | 
			
		||||
--
 | 
			
		||||
-- If this returns `true`, one should also listen for [`http_check`
 | 
			
		||||
-- events](#http-check-event) which will container further information about
 | 
			
		||||
-- whether the URL is allowed or not.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string url The URL to check.
 | 
			
		||||
-- @treturn true When this url is not invalid. This does not imply that it is
 | 
			
		||||
-- allowed - see the comment above.
 | 
			
		||||
-- @treturn[2] false When this url is invalid.
 | 
			
		||||
-- @treturn string A reason why this URL is not valid (for instance, if it is
 | 
			
		||||
-- malformed, or blocked).
 | 
			
		||||
--
 | 
			
		||||
-- @see http.checkURL For a synchronous version.
 | 
			
		||||
function checkURLAsync(url) end
 | 
			
		||||
 | 
			
		||||
--- Determine whether a URL can be requested.
 | 
			
		||||
--
 | 
			
		||||
-- If this returns `true`, one should also listen for [`http_check`
 | 
			
		||||
-- events](#http-check-event) which will container further information about
 | 
			
		||||
-- whether the URL is allowed or not.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string url The URL to check.
 | 
			
		||||
-- @treturn true When this url is valid and can be requested via @{http.request}.
 | 
			
		||||
-- @treturn[2] false When this url is invalid.
 | 
			
		||||
-- @treturn string A reason why this URL is not valid (for instance, if it is
 | 
			
		||||
-- malformed, or blocked).
 | 
			
		||||
--
 | 
			
		||||
-- @see http.checkURLAsync For an asynchronous version.
 | 
			
		||||
--
 | 
			
		||||
-- @usage
 | 
			
		||||
-- ```lua
 | 
			
		||||
-- print(http.checkURL("https://example.computercraft.cc/"))
 | 
			
		||||
-- -- => true
 | 
			
		||||
-- print(http.checkURL("http://localhost/"))
 | 
			
		||||
-- -- => false Domain not permitted
 | 
			
		||||
-- print(http.checkURL("not a url"))
 | 
			
		||||
-- -- => false URL malformed
 | 
			
		||||
-- ```
 | 
			
		||||
function checkURL(url) end
 | 
			
		||||
 | 
			
		||||
--- Open a websocket.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string url The websocket url to connect to. This should have the
 | 
			
		||||
-- `ws://` or `wss://` protocol.
 | 
			
		||||
-- @tparam[opt] { [string] = string } headers Additional headers to send as part
 | 
			
		||||
-- of the initial websocket connection.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn Websocket The websocket connection.
 | 
			
		||||
-- @treturn[2] false If the websocket connection failed.
 | 
			
		||||
-- @treturn string An error message describing why the connection failed.
 | 
			
		||||
function websocket(url, headers) end
 | 
			
		||||
 | 
			
		||||
--- Asynchronously open a websocket.
 | 
			
		||||
--
 | 
			
		||||
-- This returns immediately, a [`websocket_success`](#websocket-success-event)
 | 
			
		||||
-- or [`websocket_failure`](#websocket-failure-event) will be queued once the
 | 
			
		||||
-- request has completed.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string url The websocket url to connect to. This should have the
 | 
			
		||||
-- `ws://` or `wss://` protocol.
 | 
			
		||||
-- @tparam[opt] { [string] = string } headers Additional headers to send as part
 | 
			
		||||
-- of the initial websocket connection.
 | 
			
		||||
function websocketAsync(url, headers) end
 | 
			
		||||
 | 
			
		||||
--- A websocket, which can be used to send an receive messages with a web
 | 
			
		||||
-- server.
 | 
			
		||||
--
 | 
			
		||||
-- @type Websocket
 | 
			
		||||
-- @see http.websocket On how to open a websocket.
 | 
			
		||||
local Websocket = {}
 | 
			
		||||
 | 
			
		||||
--- Send a websocket message to the connected server.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string message The message to send.
 | 
			
		||||
-- @tparam[opt] boolean binary Whether this message should be treated as a
 | 
			
		||||
-- binary string, rather than encoded text.
 | 
			
		||||
-- @throws If the websocket has been closed.
 | 
			
		||||
function Websocket.send(message, binary) end
 | 
			
		||||
 | 
			
		||||
--- Wait for a message from the server.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number timeout The number of seconds to wait if no message is
 | 
			
		||||
-- received.
 | 
			
		||||
-- @treturn[1] string The received message.
 | 
			
		||||
-- @treturn boolean If this was a binary message.
 | 
			
		||||
-- @treturn[2] nil If the websocket was closed while waiting, or if we timed out.
 | 
			
		||||
-- @throws If the websocket has been closed.
 | 
			
		||||
function Websocket.receive(timeout) end
 | 
			
		||||
 | 
			
		||||
--- Close this websocket. This will terminate the connection, meaning messages
 | 
			
		||||
-- can no longer be sent or received along it.
 | 
			
		||||
function Websocket.close() end
 | 
			
		||||
@@ -1,24 +0,0 @@
 | 
			
		||||
function queueEvent(event, ...) end
 | 
			
		||||
function startTimer(delay) end
 | 
			
		||||
function setAlarm(time) end
 | 
			
		||||
function shutdown() end
 | 
			
		||||
function reboot() end
 | 
			
		||||
function getComputerID() end
 | 
			
		||||
computerID = getComputerID
 | 
			
		||||
function setComputerLabel(label) end
 | 
			
		||||
function getComputerLabel() end
 | 
			
		||||
computerLabel = getComputerLabel
 | 
			
		||||
function clock() end
 | 
			
		||||
function time(timezone) end
 | 
			
		||||
function day(timezone) end
 | 
			
		||||
function cancelTimer(id) end
 | 
			
		||||
function cancelAlarm(id) end
 | 
			
		||||
function epoch(timezone) end
 | 
			
		||||
function date(format, time) end
 | 
			
		||||
 | 
			
		||||
-- Defined in bios.lua
 | 
			
		||||
function loadAPI(path) end
 | 
			
		||||
function pullEvent(filter) end
 | 
			
		||||
function pullEventRaw(filter) end
 | 
			
		||||
function version() end
 | 
			
		||||
function run(env, path, ...) end
 | 
			
		||||
@@ -1,28 +0,0 @@
 | 
			
		||||
--[[-
 | 
			
		||||
Control the current pocket computer, adding or removing upgrades.
 | 
			
		||||
 | 
			
		||||
This API is only available on pocket computers. As such, you may use its
 | 
			
		||||
presence to determine what kind of computer you are using:
 | 
			
		||||
 | 
			
		||||
```lua
 | 
			
		||||
if pocket then
 | 
			
		||||
  print("On a pocket computer")
 | 
			
		||||
else
 | 
			
		||||
  print("On something else")
 | 
			
		||||
end
 | 
			
		||||
```
 | 
			
		||||
]]
 | 
			
		||||
 | 
			
		||||
--- Search the player's inventory for another upgrade, replacing the existing
 | 
			
		||||
-- one with that item if found.
 | 
			
		||||
--
 | 
			
		||||
-- This inventory search starts from the player's currently selected slot,
 | 
			
		||||
-- allowing you to prioritise upgrades.
 | 
			
		||||
--
 | 
			
		||||
-- @throws If an upgrade cannot be found.
 | 
			
		||||
function equipBack() end
 | 
			
		||||
 | 
			
		||||
--- Remove the pocket computer's current upgrade.
 | 
			
		||||
--
 | 
			
		||||
-- @throws If this pocket computer does not currently have an upgrade.
 | 
			
		||||
function unequipBack() end
 | 
			
		||||
@@ -1,120 +0,0 @@
 | 
			
		||||
--[[- Interact with redstone attached to this computer.
 | 
			
		||||
 | 
			
		||||
The @{redstone} library exposes three "types" of redstone control:
 | 
			
		||||
 - Binary input/output (@{setOutput}/@{getInput}): These simply check if a
 | 
			
		||||
   redstone wire has any input or output. A signal strength of 1 and 15 are
 | 
			
		||||
   treated the same.
 | 
			
		||||
 - Analogue input/output (@{setAnalogueOutput}/@{getAnalogueInput}): These
 | 
			
		||||
   work with the actual signal strength of the redstone wired, from 0 to 15.
 | 
			
		||||
 - Bundled cables (@{setBundledOutput}/@{getBundledInput}): These interact with
 | 
			
		||||
   "bundled" cables, such as those from Project:Red. These allow you to send
 | 
			
		||||
   16 separate on/off signals. Each channel corresponds to a colour, with the
 | 
			
		||||
   first being @{colors.white} and the last @{colors.black}.
 | 
			
		||||
 | 
			
		||||
Whenever a redstone input changes, a `redstone` event will be fired. This may
 | 
			
		||||
be used in or
 | 
			
		||||
 | 
			
		||||
This module may also be referred to as `rs`. For example, one may call
 | 
			
		||||
`rs.getSides()` instead of @{redstone.getSides}.
 | 
			
		||||
 | 
			
		||||
@module redstone
 | 
			
		||||
@usage Toggle the redstone signal above the computer every 0.5 seconds.
 | 
			
		||||
 | 
			
		||||
    while true do
 | 
			
		||||
        redstone.setOutput("top", not redstone.getOutput("top"))
 | 
			
		||||
        sleep(0.5)
 | 
			
		||||
    end
 | 
			
		||||
@usage Mimic a redstone comparator in [subtraction mode][comparator].
 | 
			
		||||
 | 
			
		||||
    while true do
 | 
			
		||||
      local rear = rs.getAnalogueInput("back")
 | 
			
		||||
      local sides = math.max(rs.getAnalogueInput("left"), rs.getAnalogueInput("right"))
 | 
			
		||||
      rs.setAnalogueOutput("front", math.max(rear - sides, 0))
 | 
			
		||||
 | 
			
		||||
      os.pullEvent("redstone") -- Wait for a change to inputs.
 | 
			
		||||
    end
 | 
			
		||||
 | 
			
		||||
[comparator]: https://minecraft.gamepedia.com/Redstone_Comparator#Subtract_signal_strength "Redstone Comparator on the Minecraft wiki."
 | 
			
		||||
]]
 | 
			
		||||
 | 
			
		||||
--- Returns a table containing the six sides of the computer. Namely, "top",
 | 
			
		||||
-- "bottom", "left", "right", "front" and "back".
 | 
			
		||||
--
 | 
			
		||||
-- @treturn { string... } A table of valid sides.
 | 
			
		||||
function getSides() end
 | 
			
		||||
 | 
			
		||||
--- Turn the redstone signal of a specific side on or off.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to set.
 | 
			
		||||
-- @tparam boolean on Whether the redstone signal should be on or off. When on,
 | 
			
		||||
-- a signal strength of 15 is emitted.
 | 
			
		||||
function setOutput(side, on) end
 | 
			
		||||
 | 
			
		||||
--- Get the current redstone output of a specific side.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to get.
 | 
			
		||||
-- @treturn boolean Whether the redstone output is on or off.
 | 
			
		||||
-- @see setOutput
 | 
			
		||||
function getOutput(side) end
 | 
			
		||||
 | 
			
		||||
--- Get the current redstone input of a specific side.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to get.
 | 
			
		||||
-- @treturn boolean Whether the redstone input is on or off.
 | 
			
		||||
function getInput(side) end
 | 
			
		||||
 | 
			
		||||
--- Set the redstone signal strength for a specific side.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to set.
 | 
			
		||||
-- @tparam number value The signal strength, between 0 and 15.
 | 
			
		||||
-- @throws If `value` is not between 0 and 15.
 | 
			
		||||
function setAnalogOutput(side, value) end
 | 
			
		||||
setAnalogueOutput = setAnalogOutput
 | 
			
		||||
 | 
			
		||||
--- Get the redstone output signal strength for a specific side.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to get.
 | 
			
		||||
-- @treturn number The output signal strength, between 0 and 15.
 | 
			
		||||
-- @see setAnalogueOutput
 | 
			
		||||
function getAnalogOutput(sid) end
 | 
			
		||||
getAnalogueOutput = getAnalogOutput
 | 
			
		||||
 | 
			
		||||
--- Get the redstone input signal strength for a specific side.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to get.
 | 
			
		||||
-- @treturn number The input signal strength, between 0 and 15.
 | 
			
		||||
function getAnalogInput(side) end
 | 
			
		||||
getAnalogueInput = getAnalogInput
 | 
			
		||||
 | 
			
		||||
--- Set the bundled cable output for a specific side.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to set.
 | 
			
		||||
-- @tparam number The colour bitmask to set.
 | 
			
		||||
-- @see colors.subtract For removing a colour from the bitmask.
 | 
			
		||||
-- @see colors.combine For adding a colour to the bitmask.
 | 
			
		||||
function setBundledOutput(side, output) end
 | 
			
		||||
 | 
			
		||||
--- Get the bundled cable output for a specific side.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to get.
 | 
			
		||||
-- @treturn number The bundled cable's output.
 | 
			
		||||
function getBundledOutput(side) end
 | 
			
		||||
 | 
			
		||||
--- Get the bundled cable input for a specific side.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to get.
 | 
			
		||||
-- @treturn number The bundled cable's input.
 | 
			
		||||
-- @see testBundledInput To determine if a specific colour is set.
 | 
			
		||||
function getBundledInput(side) end
 | 
			
		||||
 | 
			
		||||
--- Determine if a specific combination of colours are on for the given side.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam string side The side to test.
 | 
			
		||||
-- @tparam number mask The mask to test.
 | 
			
		||||
-- @see getBundledInput
 | 
			
		||||
-- @see colors.combine For adding a colour to the bitmask.
 | 
			
		||||
-- @usage Check if @{colors.white} and @{colors.black} are on for above the
 | 
			
		||||
-- computer.
 | 
			
		||||
--
 | 
			
		||||
--     print(redstone.testBundledInput("top", colors.combine(colors.white, colors.black)))
 | 
			
		||||
function testBundledInput(side, mask) end
 | 
			
		||||
@@ -1,52 +0,0 @@
 | 
			
		||||
function write(text) end
 | 
			
		||||
function scroll(lines) end
 | 
			
		||||
function setCursorPos(x, y) end
 | 
			
		||||
function setCursorBlink(blink) end
 | 
			
		||||
function getCursorPos() end
 | 
			
		||||
function getSize() end
 | 
			
		||||
function clear() end
 | 
			
		||||
function clearLine() end
 | 
			
		||||
function setTextColour(colour) end
 | 
			
		||||
setTextColor = setTextColour
 | 
			
		||||
function setBackgroundColour(colour) end
 | 
			
		||||
setBackgroundColor = setBackgroundColour
 | 
			
		||||
function isColour() end
 | 
			
		||||
isColor = isColour
 | 
			
		||||
function getTextColour() end
 | 
			
		||||
getTextColor = getTextColor
 | 
			
		||||
function getBackgroundColour() end
 | 
			
		||||
getBackgroundColor = getBackgroundColour
 | 
			
		||||
function blit(text, text_colours, background_colours) end
 | 
			
		||||
function setPaletteColour(colour, ...) end
 | 
			
		||||
setPaletteColor = setPaletteColour
 | 
			
		||||
function getPaletteColour(colour, ...) end
 | 
			
		||||
getPaletteColor = getPaletteColour
 | 
			
		||||
function nativePaletteColour(colour) end
 | 
			
		||||
nativePaletteColor = nativePaletteColour
 | 
			
		||||
 | 
			
		||||
--- @type Redirect
 | 
			
		||||
local Redirect = {}
 | 
			
		||||
 | 
			
		||||
Redirect.write = write
 | 
			
		||||
Redirect.scroll = scroll
 | 
			
		||||
Redirect.setCursorPos = setCursorPos
 | 
			
		||||
Redirect.setCursorBlink = setCursorBlink
 | 
			
		||||
Redirect.getCursorPos = getCursorPos
 | 
			
		||||
Redirect.getSize = getSize
 | 
			
		||||
Redirect.clear = clear
 | 
			
		||||
Redirect.clearLine = clearLine
 | 
			
		||||
Redirect.setTextColour = setTextColour
 | 
			
		||||
Redirect.setTextColor = setTextColor
 | 
			
		||||
Redirect.setBackgroundColour = setBackgroundColour
 | 
			
		||||
Redirect.setBackgroundColor = setBackgroundColor
 | 
			
		||||
Redirect.isColour = isColour
 | 
			
		||||
Redirect.isColor = isColor
 | 
			
		||||
Redirect.getTextColour = getTextColour
 | 
			
		||||
Redirect.getTextColor = getTextColor
 | 
			
		||||
Redirect.getBackgroundColour = getBackgroundColour
 | 
			
		||||
Redirect.getBackgroundColor = getBackgroundColor
 | 
			
		||||
Redirect.blit = blit
 | 
			
		||||
Redirect.setPaletteColour = setPaletteColour
 | 
			
		||||
Redirect.setPaletteColor = setPaletteColor
 | 
			
		||||
Redirect.getPaletteColour = getPaletteColour
 | 
			
		||||
Redirect.getPaletteColor = getPaletteColor
 | 
			
		||||
@@ -1,230 +0,0 @@
 | 
			
		||||
--- Move the turtle forward one block.
 | 
			
		||||
-- @treturn boolean Whether the turtle could successfully move.
 | 
			
		||||
-- @treturn string|nil The reason the turtle could not move.
 | 
			
		||||
function forward() end
 | 
			
		||||
 | 
			
		||||
--- Move the turtle backwards one block.
 | 
			
		||||
-- @treturn boolean Whether the turtle could successfully move.
 | 
			
		||||
-- @treturn string|nil The reason the turtle could not move.
 | 
			
		||||
function back() end
 | 
			
		||||
 | 
			
		||||
--- Move the turtle up one block.
 | 
			
		||||
-- @treturn boolean Whether the turtle could successfully move.
 | 
			
		||||
-- @treturn string|nil The reason the turtle could not move.
 | 
			
		||||
function up() end
 | 
			
		||||
 | 
			
		||||
--- Move the turtle down one block.
 | 
			
		||||
-- @treturn boolean Whether the turtle could successfully move.
 | 
			
		||||
-- @treturn string|nil The reason the turtle could not move.
 | 
			
		||||
function down() end
 | 
			
		||||
 | 
			
		||||
--- Rotate the turtle 90 degress to the left.
 | 
			
		||||
function turnLeft() end
 | 
			
		||||
 | 
			
		||||
--- Rotate the turtle 90 degress to the right.
 | 
			
		||||
function turnRight() end
 | 
			
		||||
 | 
			
		||||
--- Attempt to break the block in front of the turtle.
 | 
			
		||||
--
 | 
			
		||||
-- This requires a turtle tool capable of breaking the block. Diamond pickaxes
 | 
			
		||||
-- (mining turtles) can break any vanilla block, but other tools (such as axes)
 | 
			
		||||
-- are more limited.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] "left"|"right" side The specific tool to use.
 | 
			
		||||
-- @treturn boolean Whether a block was broken.
 | 
			
		||||
-- @treturn string|nil The reason no block was broken.
 | 
			
		||||
function dig(side) end
 | 
			
		||||
 | 
			
		||||
--- Attempt to break the block above the turtle. See @{dig} for full details.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] "left"|"right" side The specific tool to use.
 | 
			
		||||
-- @treturn boolean Whether a block was broken.
 | 
			
		||||
-- @treturn string|nil The reason no block was broken.
 | 
			
		||||
function digUp(side) end
 | 
			
		||||
 | 
			
		||||
--- Attempt to break the block below the turtle. See @{dig} for full details.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] "left"|"right" side The specific tool to use.
 | 
			
		||||
-- @treturn boolean Whether a block was broken.
 | 
			
		||||
-- @treturn string|nil The reason no block was broken.
 | 
			
		||||
function digDown(side) end
 | 
			
		||||
 | 
			
		||||
--- Attack the entity in front of the turtle.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] "left"|"right" side The specific tool to use.
 | 
			
		||||
-- @treturn boolean Whether an entity was attacked.
 | 
			
		||||
-- @treturn string|nil The reason nothing was attacked.
 | 
			
		||||
function attack(side) end
 | 
			
		||||
 | 
			
		||||
--- Attack the entity above the turtle.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] "left"|"right" side The specific tool to use.
 | 
			
		||||
-- @treturn boolean Whether an entity was attacked.
 | 
			
		||||
-- @treturn string|nil The reason nothing was attacked.
 | 
			
		||||
function attackUp(side) end
 | 
			
		||||
 | 
			
		||||
--- Attack the entity below the turtle.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] "left"|"right" side The specific tool to use.
 | 
			
		||||
-- @treturn boolean Whether an entity was attacked.
 | 
			
		||||
-- @treturn string|nil The reason nothing was attacked.
 | 
			
		||||
function attackDown(side) end
 | 
			
		||||
 | 
			
		||||
--- Place a block or item into the world in front of the turtle.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn boolean Whether the block could be placed.
 | 
			
		||||
-- @treturn string|nil The reason the block was not placed.
 | 
			
		||||
function place() end
 | 
			
		||||
 | 
			
		||||
--- Place a block or item into the world above the turtle.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn boolean Whether the block could be placed.
 | 
			
		||||
-- @treturn string|nil The reason the block was not placed.
 | 
			
		||||
function placeUp() end
 | 
			
		||||
 | 
			
		||||
--- Place a block or item into the world below the turtle.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn boolean Whether the block could be placed.
 | 
			
		||||
-- @treturn string|nil The reason the block was not placed.
 | 
			
		||||
function placeDown() end
 | 
			
		||||
 | 
			
		||||
--- Drop the currently selected stack into the inventory in front of the turtle,
 | 
			
		||||
-- or as an item into the world if there is no inventory.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number count The number of items to drop. If not given, the
 | 
			
		||||
-- entire stack will be dropped.
 | 
			
		||||
-- @treturn boolean Whether items were dropped.
 | 
			
		||||
-- @treturn string|nil The reason the no items were dropped.
 | 
			
		||||
-- @see select
 | 
			
		||||
function drop(count) end
 | 
			
		||||
 | 
			
		||||
--- Drop the currently selected stack into the inventory above the turtle, or as
 | 
			
		||||
-- an item into the world if there is no inventory.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number count The number of items to drop. If not given, the
 | 
			
		||||
-- entire stack will be dropped.
 | 
			
		||||
-- @treturn boolean Whether items were dropped.
 | 
			
		||||
-- @treturn string|nil The reason the no items were dropped.
 | 
			
		||||
-- @see select
 | 
			
		||||
function dropUp(count) end
 | 
			
		||||
 | 
			
		||||
--- Drop the currently selected stack into the inventory below the turtle, or as
 | 
			
		||||
-- an item into the world if there is no inventory.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number count The number of items to drop. If not given, the
 | 
			
		||||
-- entire stack will be dropped.
 | 
			
		||||
-- @treturn boolean Whether items were dropped.
 | 
			
		||||
-- @treturn string|nil The reason the no items were dropped.
 | 
			
		||||
-- @see select
 | 
			
		||||
function dropDown(count) end
 | 
			
		||||
 | 
			
		||||
--- Suck an item from the inventory in front of the turtle, or from an item
 | 
			
		||||
-- floating in the world.
 | 
			
		||||
--
 | 
			
		||||
-- This will pull items into the first acceptable slot, starting at the
 | 
			
		||||
-- @{select|currently selected} one.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number count The number of items to suck. If not given, up to a
 | 
			
		||||
-- stack of items will be picked up.
 | 
			
		||||
-- @treturn boolean Whether items were picked up.
 | 
			
		||||
-- @treturn string|nil The reason the no items were picked up.
 | 
			
		||||
function suck(count) end
 | 
			
		||||
 | 
			
		||||
--- Suck an item from the inventory above the turtle, or from an item floating
 | 
			
		||||
-- in the world.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number count The number of items to suck. If not given, up to a
 | 
			
		||||
-- stack of items will be picked up.
 | 
			
		||||
-- @treturn boolean Whether items were picked up.
 | 
			
		||||
-- @treturn string|nil The reason the no items were picked up.
 | 
			
		||||
function suckUp(count) end
 | 
			
		||||
 | 
			
		||||
--- Suck an item from the inventory below the turtle, or from an item floating
 | 
			
		||||
-- in the world.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number count The number of items to suck. If not given, up to a
 | 
			
		||||
-- stack of items will be picked up.
 | 
			
		||||
-- @treturn boolean Whether items were picked up.
 | 
			
		||||
-- @treturn string|nil The reason the no items were picked up.
 | 
			
		||||
function suckDown(count) end
 | 
			
		||||
 | 
			
		||||
--- Check if there is a solid block in front of the turtle. In this case, solid
 | 
			
		||||
-- refers to any non-air or liquid block.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn boolean If there is a solid block in front.
 | 
			
		||||
function detect() end
 | 
			
		||||
 | 
			
		||||
--- Check if there is a solid block above the turtle.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn boolean If there is a solid block above.
 | 
			
		||||
function detectUp() end
 | 
			
		||||
 | 
			
		||||
--- Check if there is a solid block below the turtle.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn boolean If there is a solid block below.
 | 
			
		||||
function detectDown() end
 | 
			
		||||
 | 
			
		||||
function compare() end
 | 
			
		||||
function compareUp() end
 | 
			
		||||
function compareDown() end
 | 
			
		||||
 | 
			
		||||
function inspect() end
 | 
			
		||||
function inspectUp() end
 | 
			
		||||
function inspectDown() end
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
--- Change the currently selected slot.
 | 
			
		||||
--
 | 
			
		||||
-- The selected slot is determines what slot actions like @{drop} or
 | 
			
		||||
-- @{getItemCount} act on.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam number slot The slot to select.
 | 
			
		||||
-- @see getSelectedSlot
 | 
			
		||||
function select(slot) end
 | 
			
		||||
 | 
			
		||||
--- Get the currently selected slot.
 | 
			
		||||
--
 | 
			
		||||
-- @treturn number The current slot.
 | 
			
		||||
-- @see select
 | 
			
		||||
function getSelectedSlot() end
 | 
			
		||||
 | 
			
		||||
--- Get the number of items in the given slot.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number slot The slot we wish to check. Defaults to the @{turtle.select|selected slot}.
 | 
			
		||||
-- @treturn number The number of items in this slot.
 | 
			
		||||
function getItemCount(slot) end
 | 
			
		||||
 | 
			
		||||
--- Get the remaining number of items which may be stored in this stack.
 | 
			
		||||
--
 | 
			
		||||
-- For instance, if a slot contains 13 blocks of dirt, it has room for another 51.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number slot The slot we wish to check. Defaults to the @{turtle.select|selected slot}.
 | 
			
		||||
-- @treturn number The space left in this slot.
 | 
			
		||||
function getItemSpace(slot) end
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
--- Get detailed information about the items in the given slot.
 | 
			
		||||
--
 | 
			
		||||
-- @tparam[opt] number slot The slot to get information about. Defaults to the @{turtle.select|selected slot}.
 | 
			
		||||
-- @treturn nil|table Information about the given slot, or @{nil} if it is empty.
 | 
			
		||||
-- @usage Print the current slot, assuming it contains 13 dirt.
 | 
			
		||||
--
 | 
			
		||||
--     print(textutils.serialize(turtle.getItemDetail()))
 | 
			
		||||
--     -- => {
 | 
			
		||||
--     --    name = "minecraft:dirt",
 | 
			
		||||
--     --    damage = 0,
 | 
			
		||||
--     --    count = 13,
 | 
			
		||||
--     -- }
 | 
			
		||||
function getItemDetail(slot) end
 | 
			
		||||
 | 
			
		||||
function getFuelLevel() end
 | 
			
		||||
 | 
			
		||||
function refuel(count) end
 | 
			
		||||
function compareTo(slot) end
 | 
			
		||||
function transferTo(slot, count) end
 | 
			
		||||
 | 
			
		||||
function getFuelLimit() end
 | 
			
		||||
function equipLeft() end
 | 
			
		||||
function equipRight() end
 | 
			
		||||
 | 
			
		||||
function craft(limit) end
 | 
			
		||||
							
								
								
									
										186
									
								
								doc/styles.css
									
									
									
									
									
								
							
							
						
						
									
										186
									
								
								doc/styles.css
									
									
									
									
									
								
							@@ -1,186 +0,0 @@
 | 
			
		||||
/* Basic reset on elements */
 | 
			
		||||
h1, h2, h3, h4, p, table, div, body {
 | 
			
		||||
    margin: 0;
 | 
			
		||||
    padding: 0;
 | 
			
		||||
    border: 0;
 | 
			
		||||
    font-size: 100%;
 | 
			
		||||
    font: inherit;
 | 
			
		||||
    vertical-align: baseline;
 | 
			
		||||
}
 | 
			
		||||
/* Make the page a little more airy */
 | 
			
		||||
body {
 | 
			
		||||
    margin: 20px auto;
 | 
			
		||||
    max-width: 1200px;
 | 
			
		||||
    padding: 0 10px;
 | 
			
		||||
    line-height: 1.6;
 | 
			
		||||
    color: #222;
 | 
			
		||||
    background: #fff;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/* Try to use system default fonts. */
 | 
			
		||||
body {
 | 
			
		||||
    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans",
 | 
			
		||||
                 "Droid Sans", "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
code, pre, .parameter, .type, .definition-name, .reference-code {
 | 
			
		||||
    font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/* Some definitions of basic tags */
 | 
			
		||||
code {
 | 
			
		||||
    color: #c7254e;
 | 
			
		||||
    background-color: #f9f2f4;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
p {
 | 
			
		||||
    margin: 0.9em 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
h1 {
 | 
			
		||||
    font-size: 1.5em;
 | 
			
		||||
    font-weight: lighter;
 | 
			
		||||
    border-bottom: solid 1px #aaa;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
h2, h3, h4 { margin: 1.4em 0 0.3em;}
 | 
			
		||||
h2 { font-size: 1.25em; }
 | 
			
		||||
h3 { font-size: 1.15em; font-weight: bold; }
 | 
			
		||||
h4 { font-size: 1.06em; }
 | 
			
		||||
 | 
			
		||||
a, a:visited, a:active { font-weight: bold; color: #004080; text-decoration: none; }
 | 
			
		||||
a:hover { text-decoration: underline; }
 | 
			
		||||
 | 
			
		||||
blockquote { margin-left: 3em; }
 | 
			
		||||
 | 
			
		||||
/* Stop sublists from having initial vertical space */
 | 
			
		||||
ul ul { margin-top: 0px; }
 | 
			
		||||
ol ul { margin-top: 0px; }
 | 
			
		||||
ol ol { margin-top: 0px; }
 | 
			
		||||
ul ol { margin-top: 0px; }
 | 
			
		||||
 | 
			
		||||
/* Make the target distinct; helps when we're navigating to a function */
 | 
			
		||||
a:target + * { background-color: #FFFF99; }
 | 
			
		||||
 | 
			
		||||
/* Allow linking to any subsection */
 | 
			
		||||
a[name]::before { content: "#"; }
 | 
			
		||||
 | 
			
		||||
/* Layout */
 | 
			
		||||
#main {
 | 
			
		||||
    display: flex;
 | 
			
		||||
    flex-wrap: nowrap;
 | 
			
		||||
    justify-content: space-between;
 | 
			
		||||
    min-height: calc(100vh - 100px);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#main > nav {
 | 
			
		||||
    flex-basis: 30%;
 | 
			
		||||
    min-width: 150px;
 | 
			
		||||
    max-width: 250px;
 | 
			
		||||
    background-color: #f0f0f0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
nav h1, nav ul { padding: 0em 10px; }
 | 
			
		||||
 | 
			
		||||
nav h2 {
 | 
			
		||||
    background-color:#e7e7e7;
 | 
			
		||||
    font-size: 1.1em;
 | 
			
		||||
    color:#000000;
 | 
			
		||||
    padding: 5px 10px;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
nav ul {
 | 
			
		||||
    list-style-type: none;
 | 
			
		||||
    margin: 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#content {
 | 
			
		||||
    flex-shrink: 1;
 | 
			
		||||
    flex-basis: 80%;
 | 
			
		||||
    padding: 0px 10px;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
footer {
 | 
			
		||||
    text-align: right;
 | 
			
		||||
    font-size: 0.8em;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/* The definition lists at the top of each page */
 | 
			
		||||
table.definition-list {
 | 
			
		||||
    border-collapse: collapse;
 | 
			
		||||
    width: 100%;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
table.definition-list td, table.definition-list th {
 | 
			
		||||
    border: 1px solid #cccccc;
 | 
			
		||||
    padding: 5px;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
table.definition-list th {
 | 
			
		||||
    background-color: #f0f0f0;
 | 
			
		||||
    min-width: 200px;
 | 
			
		||||
    white-space: nowrap;
 | 
			
		||||
    text-align: right;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
table.definition-list td { width: 100%; }
 | 
			
		||||
 | 
			
		||||
dl.definition dt {
 | 
			
		||||
    border-top: 1px solid #ccc;
 | 
			
		||||
    padding-top: 1em;
 | 
			
		||||
    display: flex;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
dl.definition dt .definition-name {
 | 
			
		||||
    padding: 0 0.1em;
 | 
			
		||||
    margin: 0 0.1em;
 | 
			
		||||
    flex-grow: 1;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
dl.definition dd {
 | 
			
		||||
    padding-bottom: 1em;
 | 
			
		||||
    margin: 10px 0 0 20px;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
dl.definition h3 {
 | 
			
		||||
    font-size: .95em;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/* Links to source-code */
 | 
			
		||||
.source-link { font-size: 0.8em; }
 | 
			
		||||
.source-link::before { content: '[' }
 | 
			
		||||
.source-link::after  { content: ']' }
 | 
			
		||||
a.source-link, a.source-link:visited, a.source-link:active { color: #505050; }
 | 
			
		||||
 | 
			
		||||
/* Method definitions */
 | 
			
		||||
span.parameter:after { content:":"; padding-left: 0.3em; }
 | 
			
		||||
.optional { text-decoration: underline dotted; }
 | 
			
		||||
 | 
			
		||||
/** Fancy colour display. */
 | 
			
		||||
.colour-ref {
 | 
			
		||||
    display: inline-block;
 | 
			
		||||
    width: 0.8em;
 | 
			
		||||
    height: 0.8em;
 | 
			
		||||
    margin: 0.1em 0.1em 0.3em 0.1em; /* Terrrible hack to force vertical alignment. */
 | 
			
		||||
    border: solid 1px black;
 | 
			
		||||
    box-sizing: border-box;
 | 
			
		||||
    vertical-align: middle;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/* styles for prettification of source */
 | 
			
		||||
.highlight .comment { color: #558817; }
 | 
			
		||||
.highlight .constant { color: #a8660d; }
 | 
			
		||||
.highlight .escape { color: #844631; }
 | 
			
		||||
.highlight .keyword { color: #aa5050; font-weight: bold; }
 | 
			
		||||
.highlight .library { color: #0e7c6b; }
 | 
			
		||||
.highlight .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
 | 
			
		||||
.highlight .string { color: #8080ff; }
 | 
			
		||||
.highlight .literal-kw { color: #8080ff; }
 | 
			
		||||
.highlight .number { color: #f8660d; }
 | 
			
		||||
.highlight .operator { color: #2239a8; font-weight: bold; }
 | 
			
		||||
.highlight .preprocessor, pre .prepro { color: #a33243; }
 | 
			
		||||
.highlight .global { color: #800080; }
 | 
			
		||||
.highlight .user-keyword { color: #800080; }
 | 
			
		||||
.highlight .prompt { color: #558817; }
 | 
			
		||||
.highlight .url { color: #272fc2; text-decoration: underline; }
 | 
			
		||||
@@ -1,7 +1,17 @@
 | 
			
		||||
# Done to increase the memory available to gradle.
 | 
			
		||||
org.gradle.jvmargs=-Xmx1G
 | 
			
		||||
 | 
			
		||||
# Mod properties
 | 
			
		||||
mod_version=1.89.0
 | 
			
		||||
mod_version=1.94.0
 | 
			
		||||
 | 
			
		||||
# Minecraft properties
 | 
			
		||||
mc_version=1.12.2
 | 
			
		||||
forge_version=14.23.4.2749
 | 
			
		||||
mappings_version=snapshot_20180724
 | 
			
		||||
mc_version=1.16.2
 | 
			
		||||
mappings_version=31
 | 
			
		||||
 | 
			
		||||
# Dependencies
 | 
			
		||||
cloth_config_version=4.8.1
 | 
			
		||||
fabric_api_version=0.19.0+build.398-1.16
 | 
			
		||||
fabric_loader_version=0.9.2+build.206
 | 
			
		||||
jankson_version=1.2.0
 | 
			
		||||
modmenu_version=1.14.6+
 | 
			
		||||
cloth_api_version=1.4.5
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										
											BIN
										
									
								
								gradle/wrapper/gradle-wrapper.jar
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								gradle/wrapper/gradle-wrapper.jar
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										5
									
								
								gradle/wrapper/gradle-wrapper.properties
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								gradle/wrapper/gradle-wrapper.properties
									
									
									
									
										vendored
									
									
								
							@@ -1,5 +1,6 @@
 | 
			
		||||
#Tue Jul 07 13:15:43 EDT 2020
 | 
			
		||||
distributionUrl=https\://services.gradle.org/distributions/gradle-6.6.1-all.zip
 | 
			
		||||
distributionBase=GRADLE_USER_HOME
 | 
			
		||||
distributionPath=wrapper/dists
 | 
			
		||||
zipStoreBase=GRADLE_USER_HOME
 | 
			
		||||
zipStorePath=wrapper/dists
 | 
			
		||||
distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-bin.zip
 | 
			
		||||
zipStoreBase=GRADLE_USER_HOME
 | 
			
		||||
 
 | 
			
		||||
@@ -1,95 +0,0 @@
 | 
			
		||||
; -*- mode: Lisp;-*-
 | 
			
		||||
 | 
			
		||||
(sources
 | 
			
		||||
  /doc/stub/
 | 
			
		||||
  /src/main/resources/*/computercraft/lua/bios.lua
 | 
			
		||||
  /src/main/resources/*/computercraft/lua/rom/
 | 
			
		||||
  /src/test/resources/test-rom)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
(doc
 | 
			
		||||
  (title "CC: Tweaked")
 | 
			
		||||
  (index doc/index.md)
 | 
			
		||||
  (source-link https://github.com/SquidDev-CC/CC-Tweaked/blob/${commit}/${path}#L${line})
 | 
			
		||||
 | 
			
		||||
  (library-path
 | 
			
		||||
    /doc/stub/
 | 
			
		||||
 | 
			
		||||
    /src/main/resources/*/computercraft/lua/rom/apis
 | 
			
		||||
    /src/main/resources/*/computercraft/lua/rom/apis/command
 | 
			
		||||
    /src/main/resources/*/computercraft/lua/rom/apis/turtle
 | 
			
		||||
 | 
			
		||||
    /src/main/resources/*/computercraft/lua/rom/modules/main
 | 
			
		||||
    /src/main/resources/*/computercraft/lua/rom/modules/command
 | 
			
		||||
    /src/main/resources/*/computercraft/lua/rom/modules/turtle))
 | 
			
		||||
 | 
			
		||||
(at /
 | 
			
		||||
  (linters
 | 
			
		||||
    syntax:string-index
 | 
			
		||||
 | 
			
		||||
    ;; It'd be nice to avoid this, but right now there's a lot of instances of
 | 
			
		||||
    ;; it.
 | 
			
		||||
    -var:set-loop
 | 
			
		||||
 | 
			
		||||
    ;; It's useful to name arguments for documentation, so we allow this. It'd
 | 
			
		||||
    ;; be good to find a compromise in the future, but this works for now.
 | 
			
		||||
    -var:unused-arg)
 | 
			
		||||
 | 
			
		||||
  (lint
 | 
			
		||||
    (bracket-spaces
 | 
			
		||||
      (call no-space)
 | 
			
		||||
      (function-args no-space)
 | 
			
		||||
      (parens no-space)
 | 
			
		||||
      (table space)
 | 
			
		||||
      (index no-space))
 | 
			
		||||
 | 
			
		||||
    ;; colours imports from colors, and we don't handle that right now.
 | 
			
		||||
    ;; keys is entirely dynamic, so we skip it.
 | 
			
		||||
    (dynamic-modules colours keys)
 | 
			
		||||
 | 
			
		||||
    (globals
 | 
			
		||||
      :max
 | 
			
		||||
      _CC_DEFAULT_SETTINGS
 | 
			
		||||
      _CC_DISABLE_LUA51_FEATURES
 | 
			
		||||
      ;; Ideally we'd pick these up from bios.lua, but illuaminate currently
 | 
			
		||||
      ;; isn't smart enough.
 | 
			
		||||
      sleep write printError read rs)))
 | 
			
		||||
 | 
			
		||||
;; We disable the unused global linter in bios.lua and the APIs. In the future
 | 
			
		||||
;; hopefully we'll get illuaminate to handle this.
 | 
			
		||||
(at
 | 
			
		||||
  (/src/main/resources/*/computercraft/lua/bios.lua
 | 
			
		||||
   /src/main/resources/*/computercraft/lua/rom/apis/)
 | 
			
		||||
  (linters -var:unused-global)
 | 
			
		||||
  (lint (allow-toplevel-global true)))
 | 
			
		||||
 | 
			
		||||
;; Silence some variable warnings in documentation stubs.
 | 
			
		||||
(at /doc/stub
 | 
			
		||||
  (linters -var:unused-global)
 | 
			
		||||
  (lint (allow-toplevel-global true)))
 | 
			
		||||
 | 
			
		||||
;; Suppress warnings for currently undocumented modules.
 | 
			
		||||
(at
 | 
			
		||||
  (/doc/stub/fs.lua
 | 
			
		||||
   /doc/stub/http.lua
 | 
			
		||||
   /doc/stub/os.lua
 | 
			
		||||
   /doc/stub/term.lua
 | 
			
		||||
   /doc/stub/turtle.lua
 | 
			
		||||
   /src/main/resources/*/computercraft/lua/rom/apis/io.lua
 | 
			
		||||
   /src/main/resources/*/computercraft/lua/rom/apis/window.lua)
 | 
			
		||||
 | 
			
		||||
  (linters -doc:undocumented -doc:undocumented-arg))
 | 
			
		||||
 | 
			
		||||
;; These currently rely on unknown references.
 | 
			
		||||
(at
 | 
			
		||||
  (/src/main/resources/*/computercraft/lua/rom/apis/textutils.lua
 | 
			
		||||
   /src/main/resources/*/computercraft/lua/rom/modules/main/cc/completion.lua
 | 
			
		||||
   /src/main/resources/*/computercraft/lua/rom/modules/main/cc/shell/completion.lua
 | 
			
		||||
   /src/main/resources/*/computercraft/lua/rom/programs/shell.lua)
 | 
			
		||||
  (linters -doc:unresolved-reference))
 | 
			
		||||
 | 
			
		||||
(at /src/test/resources/test-rom
 | 
			
		||||
  (lint
 | 
			
		||||
    (globals
 | 
			
		||||
      :max sleep write
 | 
			
		||||
      cct_test describe expect howlci fail it pending stub)))
 | 
			
		||||
| 
		 Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 2.2 KiB  | 
							
								
								
									
										289
									
								
								patchwork.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										289
									
								
								patchwork.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,289 @@
 | 
			
		||||
# Just my list of things I have ported over
 | 
			
		||||
 | 
			
		||||
Format for the changelog of ported stuff
 | 
			
		||||
```
 | 
			
		||||
commit    // Shows commit from CC:T
 | 
			
		||||
commit2   // Shows a commit that is the same thing, just a clean up, only if right after
 | 
			
		||||
Title     // Commit Title
 | 
			
		||||
SubScript // Desc of commit
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
If a edit that is present in CC:T is not needed, I will skip over it.
 | 
			
		||||
Any and all references to an issue number, are to be found on CC:T's repo. 
 | 
			
		||||
 | 
			
		||||
Any commit that starts with `[Patchwork]` are purely edits made by my hand, and not based on other commits from CC:T, this is to help differentiate my changes from the official changes
 | 
			
		||||
 | 
			
		||||
Lines that are found above a commit in this log like this one, (excluding this one) are comments about how i had to implement things that are not a simple 1:1 (excluding fabric/forge differences) conversion
 | 
			
		||||
 | 
			
		||||
```md
 | 
			
		||||
5155e18de279a193c558aa029963486fd1294769
 | 
			
		||||
Added translation for Vietnamese
 | 
			
		||||
Co-authored-by: Boom <boom@flyingpackets.net>
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
7e121ff72f2b1504cd6af47b57500876682bac45
 | 
			
		||||
ae6124d1f477487abab1858abde8c4ec49dfee3c
 | 
			
		||||
Translations for Vienamese
 | 
			
		||||
Co-authored-by: Boom <boom@flyingpackets.net>
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
59de21eae29849988e77fad6bc335f5ce78dfec7
 | 
			
		||||
Handle tabs when parsing JSON
 | 
			
		||||
Fixes #539
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
748ebbe66bf0a4239bde34f557e4b4b75d61d990
 | 
			
		||||
Bump to 1.92.0
 | 
			
		||||
A tiny release, but there's new features so it's technically a minor
 | 
			
		||||
bump.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Cherry Picked because this update was partially related to forge updates rather than mod updates
 | 
			
		||||
```
 | 
			
		||||
8b4a01df27ff7f6fa9ffd9c2188c6e3166edd515
 | 
			
		||||
Update to Minecraft 1.16.3
 | 
			
		||||
 | 
			
		||||
I hope the Fabric folks now realise this is gonna be a race of who can
 | 
			
		||||
update first :p. Either way, this was a very easy update - only changes
 | 
			
		||||
were due to unrelated Forge changes.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
87393e8aef9ddfaca465d626ee7cff5ff499a7e8
 | 
			
		||||
Fix additional `-` in docs
 | 
			
		||||
 | 
			
		||||
Why isn't this automatically stripped! Bad squid.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
275ca58a82c627128a145a8754cbe32568536bd9
 | 
			
		||||
HTTP rules now allow filtering by port
 | 
			
		||||
 | 
			
		||||
The HTTP filtering system becomes even more complex! Though in this
 | 
			
		||||
case, it's pretty minimal, and definitely worth doing.
 | 
			
		||||
 | 
			
		||||
For instance, the following rule will allow connecting to localhost on
 | 
			
		||||
port :8080.
 | 
			
		||||
 | 
			
		||||
    [[http.rules]]
 | 
			
		||||
    host = "127.0.0.1"
 | 
			
		||||
    port = 8080
 | 
			
		||||
    action = "allow"
 | 
			
		||||
 | 
			
		||||
    # Other rules as before.
 | 
			
		||||
 | 
			
		||||
Closes #540
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
The alterations in ColourUtils.java were not needed so they were not ported over
 | 
			
		||||
```
 | 
			
		||||
6f868849ab2f264508e12c184cc56f2632aaf5bc
 | 
			
		||||
Use tags to check if something is a dye
 | 
			
		||||
 | 
			
		||||
We half did this already, just needed to change a couple of checks.
 | 
			
		||||
Closes #541.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
6cee4efcd3610536ee74330cd728f7371011e5a8
 | 
			
		||||
Fix incorrect open container check
 | 
			
		||||
 | 
			
		||||
Was this always broken, or did it happen in a Minecraft update? Don't
 | 
			
		||||
know, but it's a very silly mistake either way. Fixes #544
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
0832974725b2478c5227b81f82c35bbf03cf6aba
 | 
			
		||||
Translations for Swedish
 | 
			
		||||
 | 
			
		||||
Co-authored-by: David Isaksson <davidisaksson93@gmail.com>
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
84036d97d99efd8762e0170002060ae3471508bf
 | 
			
		||||
Fix io.open documentation
 | 
			
		||||
 | 
			
		||||
Well, that was silly.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
I set the default properties for computers as `Block.GLASS` and then set their strength to `2F` and their soundgroup to stone
 | 
			
		||||
```
 | 
			
		||||
8472112fc1eaad18ed6ed2c6c62b040fe421e81a
 | 
			
		||||
Don't propagate adjacent redstone signals for computers (#549)
 | 
			
		||||
 | 
			
		||||
Minecraft propagates "strong" redstone signals (such as those directly
 | 
			
		||||
from comparators or repeaters) through solid blocks. This includes
 | 
			
		||||
computers, which is a little annoying as it means one cannot feed
 | 
			
		||||
redstone wire from one side and a repeater from another.
 | 
			
		||||
 | 
			
		||||
This changes computers to not propagate strong redstone signals, in the
 | 
			
		||||
same way transparent blocks like glass do.
 | 
			
		||||
 | 
			
		||||
Closes #548.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
30d35883b83831900b34040f0131c7e06f5c3e52
 | 
			
		||||
Fix my docs
 | 
			
		||||
 | 
			
		||||
Thanks @plt-hokusai. Kinda embarrassing this slipped through - I
 | 
			
		||||
evidently need to lint examples too.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
34a2c835d412c0d9e1fb20a42b7f2cd2738289c7
 | 
			
		||||
Add color table to docs (#553)
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
All API Documentation updates, 
 | 
			
		||||
`Not Needed` for this repo.
 | 
			
		||||
``` 
 | 
			
		||||
93068402a2ffec00eedb8fe2d859ebdc005a1989
 | 
			
		||||
Document remaining OS functions (#554)
 | 
			
		||||
 | 
			
		||||
01d81cb91da938836f953b290ad6b8fc87cb7e35
 | 
			
		||||
Update illuaminate CSS for deprecation (#556)
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
``` 
 | 
			
		||||
Not Needed
 | 
			
		||||
4766833cf2d041ed179529eecb9402ad09b2b79b
 | 
			
		||||
Bump JEI/crafttweaker versions
 | 
			
		||||
 | 
			
		||||
In my defence, they weren't out when I started the 1.15 update.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
``` 
 | 
			
		||||
bf6053906dc6a3c7b0d40d5b097e745dce1f33bc
 | 
			
		||||
Fix TBO norm issues on old GPUs
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
``` 
 | 
			
		||||
Not Needed
 | 
			
		||||
113b560a201dbdea9de2a2ef536bcce1d6e51978
 | 
			
		||||
Update configuration to match latest illuaminate
 | 
			
		||||
 | 
			
		||||
Ooooooh, it's all fancy now. Well, that or horrifically broken.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
c334423d42ba3b653ac3a8c27bce7970457f8f96
 | 
			
		||||
Add function to get window visibility
 | 
			
		||||
 | 
			
		||||
Closes #562
 | 
			
		||||
 | 
			
		||||
Co-authored-by: devomaa <lmao@distruzione.org>
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
[WARN] Could not implement changes to the following files
 | 
			
		||||
* `src/main/java/dan200/computercraft/ComputerCraft.java` < Structure too different, cannot find equivalent to alter
 | 
			
		||||
* `src/main/java/dan200/computercraft/shared/Config.java` < Files Does not exist in this repo
 | 
			
		||||
```
 | 
			
		||||
84a6bb1cf3b0668ddc7d8c409a2477a42390e3f7
 | 
			
		||||
Make generic peripherals on by default
 | 
			
		||||
 | 
			
		||||
This is a long way away from "feature complete" as it were. However,
 | 
			
		||||
it's definitely at a point where it's suitable for general usage - I'm
 | 
			
		||||
happy with the API, and don't think I'm going to be breaking things any
 | 
			
		||||
time soon.
 | 
			
		||||
 | 
			
		||||
That said, things aren't exposed yet for Java-side public consumption. I
 | 
			
		||||
was kinda waiting until working on Plethora to actually do that, but not
 | 
			
		||||
sure if/when that'll happen.
 | 
			
		||||
 | 
			
		||||
If someone else wants to work on an integration mod (or just adding
 | 
			
		||||
integrations for their own mod), do get in touch and I can work out how
 | 
			
		||||
to expose this.
 | 
			
		||||
 | 
			
		||||
Closes #452
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
``` 
 | 
			
		||||
Not Needed
 | 
			
		||||
6aae4e576621090840724e094aa25e51696530fc
 | 
			
		||||
Remove superfluous imports
 | 
			
		||||
 | 
			
		||||
Hah, this is embarassing
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
[TODO] [M3R1-01] Code has been applied, players still dont get achievments
 | 
			
		||||
``` 
 | 
			
		||||
f6160bdc57b3d9850607c2c7c2ce9734b4963478
 | 
			
		||||
Fix players not getting advancements when they own turtles
 | 
			
		||||
 | 
			
		||||
When we construct a new ServerPlayerEntity (and thus TurtlePlayer), we
 | 
			
		||||
get the current (global) advancement state and call .setPlayer() on it.
 | 
			
		||||
 | 
			
		||||
As grantCriterion blocks FakePlayers from getting advancements, this
 | 
			
		||||
means a player will no longer receive any advancements, as the "wrong"
 | 
			
		||||
player object is being consulted.
 | 
			
		||||
 | 
			
		||||
As a temporary work around, we attempt to restore the previous player to
 | 
			
		||||
the advancement store. I'll try to upstream something into Forge to
 | 
			
		||||
resolve this properly.
 | 
			
		||||
 | 
			
		||||
Fixes #564
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
``` 
 | 
			
		||||
17a932920711a5c0361a5048c9e0a5e7a58e6364
 | 
			
		||||
Bump cct-javadoc version
 | 
			
		||||
 | 
			
		||||
Documentation will now be sorted (somewhat) correctly!
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
a6fcfb6af2fc1bef8ca3a19122c9267549202424
 | 
			
		||||
Draw in-hand pocket computers with blending
 | 
			
		||||
 | 
			
		||||
It might be worth switching to RenderTypes here, rather than a pure
 | 
			
		||||
Tesselator, but this'll do for now.
 | 
			
		||||
 | 
			
		||||
Fixes Zundrel/cc-tweaked-fabric#20.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
``` 
 | 
			
		||||
c58441b29c3715f092e7f3747bb3ec65ae5a3d29
 | 
			
		||||
Various SNBT parsing improvements
 | 
			
		||||
 | 
			
		||||
Correctly handle:
 | 
			
		||||
 - Typed arrays ([I; 1, 2, 3])
 | 
			
		||||
 - All suffixed numbers (1.2d)
 | 
			
		||||
 - Single-quoted strings
 | 
			
		||||
 | 
			
		||||
Fixes #559
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
``` 
 | 
			
		||||
e2a635b6e5f5942f999213434054e06833c5cb06
 | 
			
		||||
Dont fail when codecov is being finicky
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
666e83cf4fd0eb327f465d5b919a708790f99b00
 | 
			
		||||
Fix JSON objects failing to pass
 | 
			
		||||
 | 
			
		||||
Maybe I should run the whole test suite, not just the things I think
 | 
			
		||||
matter? Nah....
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
``` 
 | 
			
		||||
741adfa7bb2b950d2851c3f0072d6a4769f22773
 | 
			
		||||
 | 
			
		||||
Use blit to draw boxes, add colors.toBlit (#570)
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
``` 
 | 
			
		||||
d13bd2cce8d102ad7f61f557e707d6fe3731bc37
 | 
			
		||||
 | 
			
		||||
use arg[0] in all usage printouts (#571)
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
74ac5bb3d17e5bee30643a5d6702696600c06229
 | 
			
		||||
 | 
			
		||||
Bump to 1.94.0
 | 
			
		||||
```
 | 
			
		||||
@@ -1 +1,12 @@
 | 
			
		||||
rootProject.name = "cc-tweaked-${mc_version}"
 | 
			
		||||
pluginManagement {
 | 
			
		||||
    repositories {
 | 
			
		||||
        jcenter()
 | 
			
		||||
        maven {
 | 
			
		||||
            name = 'Fabric'
 | 
			
		||||
            url = 'https://maven.fabricmc.net/'
 | 
			
		||||
        }
 | 
			
		||||
        gradlePluginPortal()
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
rootProject.name = "cc-tweaked-fabric-${mc_version}"
 | 
			
		||||
 
 | 
			
		||||
@@ -1,29 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of ComputerCraft - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. Do not distribute without permission.
 | 
			
		||||
 * Send enquiries to dratcliffe@gmail.com
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.Mod;
 | 
			
		||||
import net.minecraftforge.fml.common.network.NetworkCheckHandler;
 | 
			
		||||
import net.minecraftforge.fml.relauncher.Side;
 | 
			
		||||
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A stub mod for CC: Tweaked. This doesn't have any functionality (everything of note is done in
 | 
			
		||||
 * {@link ComputerCraft}), but people may depend on this if they require CC: Tweaked functionality.
 | 
			
		||||
 */
 | 
			
		||||
@Mod(
 | 
			
		||||
    modid = "cctweaked", name = ComputerCraft.NAME, version = ComputerCraft.VERSION,
 | 
			
		||||
    acceptableRemoteVersions = "*"
 | 
			
		||||
)
 | 
			
		||||
public class CCTweaked
 | 
			
		||||
{
 | 
			
		||||
    @NetworkCheckHandler
 | 
			
		||||
    public boolean onNetworkConnect( Map<String, String> mods, Side side )
 | 
			
		||||
    {
 | 
			
		||||
        return true;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -3,665 +3,160 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. Do not distribute without permission.
 | 
			
		||||
 * Send enquiries to dratcliffe@gmail.com
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.filesystem.IMount;
 | 
			
		||||
import dan200.computercraft.api.filesystem.IWritableMount;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaAPIFactory;
 | 
			
		||||
import dan200.computercraft.api.media.IMedia;
 | 
			
		||||
import dan200.computercraft.api.media.IMediaProvider;
 | 
			
		||||
import dan200.computercraft.api.network.IPacketNetwork;
 | 
			
		||||
import dan200.computercraft.api.network.wired.IWiredElement;
 | 
			
		||||
import dan200.computercraft.api.network.wired.IWiredNode;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheralProvider;
 | 
			
		||||
import dan200.computercraft.api.permissions.ITurtlePermissionProvider;
 | 
			
		||||
import dan200.computercraft.api.pocket.IPocketUpgrade;
 | 
			
		||||
import dan200.computercraft.api.redstone.IBundledRedstoneProvider;
 | 
			
		||||
import dan200.computercraft.api.turtle.ITurtleUpgrade;
 | 
			
		||||
import static dan200.computercraft.shared.ComputerCraftRegistry.ModBlocks;
 | 
			
		||||
import static dan200.computercraft.shared.ComputerCraftRegistry.init;
 | 
			
		||||
 | 
			
		||||
import java.nio.file.Paths;
 | 
			
		||||
import java.util.EnumSet;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
import java.util.concurrent.TimeUnit;
 | 
			
		||||
import java.util.stream.Collectors;
 | 
			
		||||
import java.util.stream.Stream;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.turtle.event.TurtleAction;
 | 
			
		||||
import dan200.computercraft.core.apis.AddressPredicate;
 | 
			
		||||
import dan200.computercraft.core.apis.ApiFactories;
 | 
			
		||||
import dan200.computercraft.core.computer.MainThread;
 | 
			
		||||
import dan200.computercraft.core.filesystem.ComboMount;
 | 
			
		||||
import dan200.computercraft.core.filesystem.FileMount;
 | 
			
		||||
import dan200.computercraft.core.filesystem.JarMount;
 | 
			
		||||
import dan200.computercraft.core.tracking.Tracking;
 | 
			
		||||
import dan200.computercraft.shared.*;
 | 
			
		||||
import dan200.computercraft.shared.computer.blocks.BlockCommandComputer;
 | 
			
		||||
import dan200.computercraft.shared.computer.blocks.BlockComputer;
 | 
			
		||||
import dan200.computercraft.core.apis.http.options.Action;
 | 
			
		||||
import dan200.computercraft.core.apis.http.options.AddressRule;
 | 
			
		||||
import dan200.computercraft.core.apis.http.websocket.Websocket;
 | 
			
		||||
import dan200.computercraft.core.asm.GenericSource;
 | 
			
		||||
import dan200.computercraft.shared.common.ColourableRecipe;
 | 
			
		||||
import dan200.computercraft.shared.computer.core.ClientComputerRegistry;
 | 
			
		||||
import dan200.computercraft.shared.computer.core.ServerComputerRegistry;
 | 
			
		||||
import dan200.computercraft.shared.computer.items.ItemCommandComputer;
 | 
			
		||||
import dan200.computercraft.shared.computer.items.ItemComputer;
 | 
			
		||||
import dan200.computercraft.shared.media.items.ItemDiskExpanded;
 | 
			
		||||
import dan200.computercraft.shared.media.items.ItemDiskLegacy;
 | 
			
		||||
import dan200.computercraft.shared.media.items.ItemPrintout;
 | 
			
		||||
import dan200.computercraft.shared.media.items.ItemTreasureDisk;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.common.BlockPeripheral;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.common.ItemPeripheral;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.modem.wired.BlockCable;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.modem.wired.BlockWiredModemFull;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.modem.wired.ItemCable;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.modem.wireless.BlockAdvancedModem;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.modem.wireless.ItemAdvancedModem;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.modem.wireless.WirelessNetwork;
 | 
			
		||||
import dan200.computercraft.shared.computer.recipe.ComputerUpgradeRecipe;
 | 
			
		||||
import dan200.computercraft.shared.data.BlockNamedEntityLootCondition;
 | 
			
		||||
import dan200.computercraft.shared.data.HasComputerIdLootCondition;
 | 
			
		||||
import dan200.computercraft.shared.data.PlayerCreativeLootCondition;
 | 
			
		||||
import dan200.computercraft.shared.media.recipes.DiskRecipe;
 | 
			
		||||
import dan200.computercraft.shared.media.recipes.PrintoutRecipe;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.monitor.MonitorRenderer;
 | 
			
		||||
import dan200.computercraft.shared.pocket.items.ItemPocketComputer;
 | 
			
		||||
import dan200.computercraft.shared.pocket.peripherals.PocketModem;
 | 
			
		||||
import dan200.computercraft.shared.pocket.peripherals.PocketSpeaker;
 | 
			
		||||
import dan200.computercraft.shared.pocket.recipes.PocketComputerUpgradeRecipe;
 | 
			
		||||
import dan200.computercraft.shared.proxy.ComputerCraftProxyCommon;
 | 
			
		||||
import dan200.computercraft.shared.turtle.blocks.BlockTurtle;
 | 
			
		||||
import dan200.computercraft.shared.turtle.items.ItemTurtleAdvanced;
 | 
			
		||||
import dan200.computercraft.shared.turtle.items.ItemTurtleLegacy;
 | 
			
		||||
import dan200.computercraft.shared.turtle.items.ItemTurtleNormal;
 | 
			
		||||
import dan200.computercraft.shared.turtle.upgrades.*;
 | 
			
		||||
import dan200.computercraft.shared.util.CreativeTabMain;
 | 
			
		||||
import dan200.computercraft.shared.util.IDAssigner;
 | 
			
		||||
import dan200.computercraft.shared.util.IoUtil;
 | 
			
		||||
import dan200.computercraft.shared.wired.CapabilityWiredElement;
 | 
			
		||||
import dan200.computercraft.shared.wired.WiredNode;
 | 
			
		||||
import net.minecraft.entity.player.EntityPlayer;
 | 
			
		||||
import net.minecraft.item.ItemBlock;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.server.MinecraftServer;
 | 
			
		||||
import net.minecraft.tileentity.TileEntity;
 | 
			
		||||
import net.minecraft.util.EnumFacing;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.world.IBlockAccess;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
import net.minecraftforge.common.DimensionManager;
 | 
			
		||||
import net.minecraftforge.fml.common.*;
 | 
			
		||||
import net.minecraftforge.fml.common.event.*;
 | 
			
		||||
import net.minecraftforge.fml.relauncher.Side;
 | 
			
		||||
import dan200.computercraft.shared.turtle.recipes.TurtleRecipe;
 | 
			
		||||
import dan200.computercraft.shared.turtle.recipes.TurtleUpgradeRecipe;
 | 
			
		||||
import dan200.computercraft.shared.turtle.upgrades.TurtleAxe;
 | 
			
		||||
import dan200.computercraft.shared.turtle.upgrades.TurtleCraftingTable;
 | 
			
		||||
import dan200.computercraft.shared.turtle.upgrades.TurtleHoe;
 | 
			
		||||
import dan200.computercraft.shared.turtle.upgrades.TurtleModem;
 | 
			
		||||
import dan200.computercraft.shared.turtle.upgrades.TurtleShovel;
 | 
			
		||||
import dan200.computercraft.shared.turtle.upgrades.TurtleSpeaker;
 | 
			
		||||
import dan200.computercraft.shared.turtle.upgrades.TurtleSword;
 | 
			
		||||
import dan200.computercraft.shared.turtle.upgrades.TurtleTool;
 | 
			
		||||
import dan200.computercraft.shared.util.Config;
 | 
			
		||||
import dan200.computercraft.shared.util.ImpostorRecipe;
 | 
			
		||||
import dan200.computercraft.shared.util.ImpostorShapelessRecipe;
 | 
			
		||||
import dan200.computercraft.shared.util.ServiceUtil;
 | 
			
		||||
import org.apache.logging.log4j.LogManager;
 | 
			
		||||
import org.apache.logging.log4j.Logger;
 | 
			
		||||
 | 
			
		||||
import java.io.*;
 | 
			
		||||
import java.net.MalformedURLException;
 | 
			
		||||
import java.net.URISyntaxException;
 | 
			
		||||
import java.net.URL;
 | 
			
		||||
import java.util.*;
 | 
			
		||||
import java.util.concurrent.TimeUnit;
 | 
			
		||||
import java.util.zip.ZipEntry;
 | 
			
		||||
import java.util.zip.ZipFile;
 | 
			
		||||
import net.minecraft.item.ItemGroup;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.Identifier;
 | 
			
		||||
import net.minecraft.util.registry.Registry;
 | 
			
		||||
 | 
			
		||||
@Mod(
 | 
			
		||||
    modid = ComputerCraft.MOD_ID, name = ComputerCraft.NAME, version = ComputerCraft.VERSION,
 | 
			
		||||
    guiFactory = "dan200.computercraft.client.gui.GuiConfigCC$Factory",
 | 
			
		||||
    dependencies = "required:forge@[14.23.4.2746,)"
 | 
			
		||||
)
 | 
			
		||||
public class ComputerCraft
 | 
			
		||||
{
 | 
			
		||||
import net.fabricmc.api.ModInitializer;
 | 
			
		||||
import net.fabricmc.fabric.api.client.itemgroup.FabricItemGroupBuilder;
 | 
			
		||||
import net.fabricmc.loader.api.FabricLoader;
 | 
			
		||||
 | 
			
		||||
public final class ComputerCraft implements ModInitializer {
 | 
			
		||||
    public static final String MOD_ID = "computercraft";
 | 
			
		||||
    static final String VERSION = "${version}";
 | 
			
		||||
    static final String NAME = "CC: Tweaked";
 | 
			
		||||
 | 
			
		||||
    // Configuration options
 | 
			
		||||
    public static final String[] DEFAULT_HTTP_WHITELIST = new String[] { "*" };
 | 
			
		||||
    public static final String[] DEFAULT_HTTP_WHITELIST = new String[] {"*"};
 | 
			
		||||
    public static final String[] DEFAULT_HTTP_BLACKLIST = new String[] {
 | 
			
		||||
        "127.0.0.0/8",
 | 
			
		||||
        "10.0.0.0/8",
 | 
			
		||||
        "172.16.0.0/12",
 | 
			
		||||
        "192.168.0.0/16",
 | 
			
		||||
        "fd00::/8",
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
        "0.0.0.0/8"
 | 
			
		||||
        };
 | 
			
		||||
    public static final int terminalWidth_computer = 51;
 | 
			
		||||
    public static final int terminalHeight_computer = 19;
 | 
			
		||||
    public static final int terminalWidth_turtle = 39;
 | 
			
		||||
    public static final int terminalHeight_turtle = 13;
 | 
			
		||||
    public static final int terminalWidth_pocketComputer = 26;
 | 
			
		||||
    public static final int terminalHeight_pocketComputer = 20;
 | 
			
		||||
    // Registries
 | 
			
		||||
    public static final ClientComputerRegistry clientComputerRegistry = new ClientComputerRegistry();
 | 
			
		||||
    public static final ServerComputerRegistry serverComputerRegistry = new ServerComputerRegistry();
 | 
			
		||||
    // Logging
 | 
			
		||||
    public static final Logger log = LogManager.getLogger(MOD_ID);
 | 
			
		||||
    public static ItemGroup MAIN_GROUP = FabricItemGroupBuilder.build(new Identifier(MOD_ID, "main"), () -> new ItemStack(ModBlocks.COMPUTER_NORMAL));
 | 
			
		||||
    public static boolean commandRequireCreative = false;
 | 
			
		||||
    public static MonitorRenderer monitorRenderer = MonitorRenderer.BEST;
 | 
			
		||||
    public static int computerSpaceLimit = 1000 * 1000;
 | 
			
		||||
    public static int floppySpaceLimit = 125 * 1000;
 | 
			
		||||
    public static int maximumFilesOpen = 128;
 | 
			
		||||
    public static boolean disable_lua51_features = false;
 | 
			
		||||
    public static String default_computer_settings = "";
 | 
			
		||||
    public static boolean debug_enable = true;
 | 
			
		||||
    public static boolean logPeripheralErrors = true;
 | 
			
		||||
    public static boolean commandRequireCreative = true;
 | 
			
		||||
 | 
			
		||||
    public static boolean logPeripheralErrors = false;
 | 
			
		||||
    public static int computer_threads = 1;
 | 
			
		||||
    public static long maxMainGlobalTime = TimeUnit.MILLISECONDS.toNanos( 10 );
 | 
			
		||||
    public static long maxMainComputerTime = TimeUnit.MILLISECONDS.toNanos( 5 );
 | 
			
		||||
 | 
			
		||||
    public static long maxMainGlobalTime = TimeUnit.MILLISECONDS.toNanos(10);
 | 
			
		||||
    public static long maxMainComputerTime = TimeUnit.MILLISECONDS.toNanos(5);
 | 
			
		||||
    public static boolean http_enable = true;
 | 
			
		||||
    public static boolean http_websocket_enable = true;
 | 
			
		||||
    public static AddressPredicate http_whitelist = new AddressPredicate( DEFAULT_HTTP_WHITELIST );
 | 
			
		||||
    public static AddressPredicate http_blacklist = new AddressPredicate( DEFAULT_HTTP_BLACKLIST );
 | 
			
		||||
 | 
			
		||||
    public static int httpTimeout = 30000;
 | 
			
		||||
    public static int httpMaxRequests = 16;
 | 
			
		||||
    public static long httpMaxDownload = 16 * 1024 * 1024;
 | 
			
		||||
    public static long httpMaxUpload = 4 * 1024 * 1024;
 | 
			
		||||
    public static int httpMaxWebsockets = 4;
 | 
			
		||||
    public static int httpMaxWebsocketMessage = 128 * 1024;
 | 
			
		||||
 | 
			
		||||
    public static int httpMaxWebsocketMessage = Websocket.MAX_MESSAGE_SIZE;
 | 
			
		||||
    public static boolean enableCommandBlock = false;
 | 
			
		||||
    public static int modem_range = 64;
 | 
			
		||||
    public static int modem_highAltitudeRange = 384;
 | 
			
		||||
    public static int modem_rangeDuringStorm = 64;
 | 
			
		||||
    public static int modem_highAltitudeRangeDuringStorm = 384;
 | 
			
		||||
    public static int maxNotesPerTick = 8;
 | 
			
		||||
    public static MonitorRenderer monitorRenderer = MonitorRenderer.BEST;
 | 
			
		||||
    public static long monitorBandwidth = 1_000_000;
 | 
			
		||||
 | 
			
		||||
    public static boolean turtlesNeedFuel = true;
 | 
			
		||||
    public static int turtleFuelLimit = 20000;
 | 
			
		||||
    public static int advancedTurtleFuelLimit = 100000;
 | 
			
		||||
    public static boolean turtlesObeyBlockProtection = true;
 | 
			
		||||
    public static boolean turtlesCanPush = true;
 | 
			
		||||
    public static EnumSet<TurtleAction> turtleDisabledActions = EnumSet.noneOf( TurtleAction.class );
 | 
			
		||||
    public static EnumSet<TurtleAction> turtleDisabledActions = EnumSet.noneOf(TurtleAction.class);
 | 
			
		||||
    public static int monitorWidth = 8;
 | 
			
		||||
    public static int monitorHeight = 6;
 | 
			
		||||
    public static double monitorDistanceSq = 4096;
 | 
			
		||||
 | 
			
		||||
    public static final int terminalWidth_computer = 51;
 | 
			
		||||
    public static final int terminalHeight_computer = 19;
 | 
			
		||||
    public static List<AddressRule> httpRules = buildHttpRulesFromConfig(DEFAULT_HTTP_BLACKLIST, DEFAULT_HTTP_WHITELIST);
 | 
			
		||||
 | 
			
		||||
    public static final int terminalWidth_turtle = 39;
 | 
			
		||||
    public static final int terminalHeight_turtle = 13;
 | 
			
		||||
 | 
			
		||||
    public static final int terminalWidth_pocketComputer = 26;
 | 
			
		||||
    public static final int terminalHeight_pocketComputer = 20;
 | 
			
		||||
 | 
			
		||||
    // Blocks and Items
 | 
			
		||||
    public static final class Blocks
 | 
			
		||||
    {
 | 
			
		||||
        public static BlockComputer computer;
 | 
			
		||||
        public static BlockCommandComputer commandComputer;
 | 
			
		||||
 | 
			
		||||
        public static BlockTurtle turtle;
 | 
			
		||||
        public static BlockTurtle turtleExpanded;
 | 
			
		||||
        public static BlockTurtle turtleAdvanced;
 | 
			
		||||
 | 
			
		||||
        public static BlockPeripheral peripheral;
 | 
			
		||||
        public static BlockCable cable;
 | 
			
		||||
        public static BlockAdvancedModem advancedModem;
 | 
			
		||||
        public static BlockWiredModemFull wiredModemFull;
 | 
			
		||||
    public static List<AddressRule> buildHttpRulesFromConfig(String[] blacklist, String[] whitelist) {
 | 
			
		||||
        return Stream.concat(Stream.of(blacklist)
 | 
			
		||||
                        .map( x -> AddressRule.parse( x, null, Action.DENY.toPartial()))
 | 
			
		||||
                        .filter(Objects::nonNull),
 | 
			
		||||
                Stream.of(whitelist)
 | 
			
		||||
                        .map( x -> AddressRule.parse( x, null, Action.ALLOW.toPartial()))
 | 
			
		||||
                        .filter(Objects::nonNull))
 | 
			
		||||
                .collect(Collectors.toList());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static final class Items
 | 
			
		||||
    {
 | 
			
		||||
        public static ItemComputer computer;
 | 
			
		||||
        public static ItemCommandComputer commandComputer;
 | 
			
		||||
 | 
			
		||||
        public static ItemTurtleLegacy turtle;
 | 
			
		||||
        public static ItemTurtleNormal turtleExpanded;
 | 
			
		||||
        public static ItemTurtleAdvanced turtleAdvanced;
 | 
			
		||||
 | 
			
		||||
        public static ItemPocketComputer pocketComputer;
 | 
			
		||||
 | 
			
		||||
        public static ItemDiskLegacy disk;
 | 
			
		||||
        public static ItemDiskExpanded diskExpanded;
 | 
			
		||||
        public static ItemTreasureDisk treasureDisk;
 | 
			
		||||
 | 
			
		||||
        public static ItemPrintout printout;
 | 
			
		||||
 | 
			
		||||
        public static ItemPeripheral peripheral;
 | 
			
		||||
        public static ItemAdvancedModem advancedModem;
 | 
			
		||||
        public static ItemCable cable;
 | 
			
		||||
        public static ItemBlock wiredModemFull;
 | 
			
		||||
    @Override
 | 
			
		||||
    public void onInitialize() {
 | 
			
		||||
        Config.load(Paths.get(FabricLoader.getInstance()
 | 
			
		||||
                                          .getConfigDir()
 | 
			
		||||
                                          .toFile()
 | 
			
		||||
                                          .getPath(), MOD_ID + ".json5"));
 | 
			
		||||
        ComputerCraftProxyCommon.init();
 | 
			
		||||
        Registry.register(Registry.RECIPE_SERIALIZER, new Identifier(ComputerCraft.MOD_ID, "colour"), ColourableRecipe.SERIALIZER);
 | 
			
		||||
        Registry.register(Registry.RECIPE_SERIALIZER, new Identifier(ComputerCraft.MOD_ID, "computer_upgrade"), ComputerUpgradeRecipe.SERIALIZER);
 | 
			
		||||
        Registry.register(Registry.RECIPE_SERIALIZER,
 | 
			
		||||
                          new Identifier(ComputerCraft.MOD_ID, "pocket_computer_upgrade"),
 | 
			
		||||
                          PocketComputerUpgradeRecipe.SERIALIZER);
 | 
			
		||||
        Registry.register(Registry.RECIPE_SERIALIZER, new Identifier(ComputerCraft.MOD_ID, "disk"), DiskRecipe.SERIALIZER);
 | 
			
		||||
        Registry.register(Registry.RECIPE_SERIALIZER, new Identifier(ComputerCraft.MOD_ID, "printout"), PrintoutRecipe.SERIALIZER);
 | 
			
		||||
        Registry.register(Registry.RECIPE_SERIALIZER, new Identifier(ComputerCraft.MOD_ID, "turtle"), TurtleRecipe.SERIALIZER);
 | 
			
		||||
        Registry.register(Registry.RECIPE_SERIALIZER, new Identifier(ComputerCraft.MOD_ID, "turtle_upgrade"), TurtleUpgradeRecipe.SERIALIZER);
 | 
			
		||||
        Registry.register(Registry.RECIPE_SERIALIZER, new Identifier(ComputerCraft.MOD_ID, "impostor_shaped"), ImpostorRecipe.SERIALIZER);
 | 
			
		||||
        Registry.register(Registry.RECIPE_SERIALIZER, new Identifier(ComputerCraft.MOD_ID, "impostor_shapeless"), ImpostorShapelessRecipe.SERIALIZER);
 | 
			
		||||
        Registry.register(Registry.LOOT_CONDITION_TYPE, new Identifier(ComputerCraft.MOD_ID, "block_named"), BlockNamedEntityLootCondition.TYPE);
 | 
			
		||||
        Registry.register(Registry.LOOT_CONDITION_TYPE, new Identifier(ComputerCraft.MOD_ID, "player_creative"), PlayerCreativeLootCondition.TYPE);
 | 
			
		||||
        Registry.register(Registry.LOOT_CONDITION_TYPE, new Identifier(ComputerCraft.MOD_ID, "has_id"), HasComputerIdLootCondition.TYPE);
 | 
			
		||||
        init();
 | 
			
		||||
        GenericSource.setup( () -> ServiceUtil.loadServices( GenericSource.class ));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static final class TurtleUpgrades
 | 
			
		||||
    {
 | 
			
		||||
        public static TurtleModem wirelessModem;
 | 
			
		||||
        public static TurtleModem advancedModem;
 | 
			
		||||
        public static TurtleSpeaker speaker;
 | 
			
		||||
 | 
			
		||||
        public static TurtleCraftingTable craftingTable;
 | 
			
		||||
        public static TurtleSword diamondSword;
 | 
			
		||||
        public static TurtleShovel diamondShovel;
 | 
			
		||||
        public static TurtleTool diamondPickaxe;
 | 
			
		||||
        public static TurtleAxe diamondAxe;
 | 
			
		||||
        public static TurtleHoe diamondHoe;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static final class PocketUpgrades
 | 
			
		||||
    {
 | 
			
		||||
        public static PocketModem wirelessModem;
 | 
			
		||||
        public static PocketModem advancedModem;
 | 
			
		||||
        public static PocketSpeaker speaker;
 | 
			
		||||
 | 
			
		||||
        @Deprecated
 | 
			
		||||
        public static PocketSpeaker pocketSpeaker;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static final class Upgrades
 | 
			
		||||
    {
 | 
			
		||||
        public static TurtleModem advancedModem;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Registries
 | 
			
		||||
    public static final ClientComputerRegistry clientComputerRegistry = new ClientComputerRegistry();
 | 
			
		||||
    public static final ServerComputerRegistry serverComputerRegistry = new ServerComputerRegistry();
 | 
			
		||||
 | 
			
		||||
    // Creative
 | 
			
		||||
    public static CreativeTabMain mainCreativeTab;
 | 
			
		||||
 | 
			
		||||
    // Logging
 | 
			
		||||
    public static Logger log;
 | 
			
		||||
 | 
			
		||||
    // Peripheral providers. This is still here to ensure compatibility with Plethora and Computronics
 | 
			
		||||
    public static List<IPeripheralProvider> peripheralProviders = new ArrayList<>();
 | 
			
		||||
 | 
			
		||||
    // Implementation
 | 
			
		||||
    @Mod.Instance( ComputerCraft.MOD_ID )
 | 
			
		||||
    public static ComputerCraft instance;
 | 
			
		||||
 | 
			
		||||
    @SidedProxy(
 | 
			
		||||
        clientSide = "dan200.computercraft.client.proxy.ComputerCraftProxyClient",
 | 
			
		||||
        serverSide = "dan200.computercraft.shared.proxy.ComputerCraftProxyCommon"
 | 
			
		||||
    )
 | 
			
		||||
    private static ComputerCraftProxyCommon proxy;
 | 
			
		||||
 | 
			
		||||
    @Mod.EventHandler
 | 
			
		||||
    public void preInit( FMLPreInitializationEvent event )
 | 
			
		||||
    {
 | 
			
		||||
        log = event.getModLog();
 | 
			
		||||
 | 
			
		||||
        // Load config
 | 
			
		||||
        Config.load( event.getSuggestedConfigurationFile() );
 | 
			
		||||
 | 
			
		||||
        proxy.preInit();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Mod.EventHandler
 | 
			
		||||
    public void init( FMLInitializationEvent event )
 | 
			
		||||
    {
 | 
			
		||||
        proxy.init();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Mod.EventHandler
 | 
			
		||||
    public void onServerStarting( FMLServerStartingEvent event )
 | 
			
		||||
    {
 | 
			
		||||
        ComputerCraftProxyCommon.initServer( event.getServer() );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Mod.EventHandler
 | 
			
		||||
    public void onServerStart( FMLServerStartedEvent event )
 | 
			
		||||
    {
 | 
			
		||||
        if( FMLCommonHandler.instance().getEffectiveSide() == Side.SERVER )
 | 
			
		||||
        {
 | 
			
		||||
            ComputerCraft.serverComputerRegistry.reset();
 | 
			
		||||
            WirelessNetwork.resetNetworks();
 | 
			
		||||
            MainThread.reset();
 | 
			
		||||
            Tracking.reset();
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Mod.EventHandler
 | 
			
		||||
    public void onServerStopped( FMLServerStoppedEvent event )
 | 
			
		||||
    {
 | 
			
		||||
        if( FMLCommonHandler.instance().getEffectiveSide() == Side.SERVER )
 | 
			
		||||
        {
 | 
			
		||||
            ComputerCraft.serverComputerRegistry.reset();
 | 
			
		||||
            WirelessNetwork.resetNetworks();
 | 
			
		||||
            MainThread.reset();
 | 
			
		||||
            Tracking.reset();
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static String getVersion()
 | 
			
		||||
    {
 | 
			
		||||
        return VERSION;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static File getBaseDir()
 | 
			
		||||
    {
 | 
			
		||||
        return FMLCommonHandler.instance().getMinecraftServerInstance().getDataDirectory();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static File getResourcePackDir()
 | 
			
		||||
    {
 | 
			
		||||
        return new File( getBaseDir(), "resourcepacks" );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static void registerPermissionProvider( ITurtlePermissionProvider provider )
 | 
			
		||||
    {
 | 
			
		||||
        TurtlePermissions.register( provider );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static void registerPocketUpgrade( IPocketUpgrade upgrade )
 | 
			
		||||
    {
 | 
			
		||||
        dan200.computercraft.shared.PocketUpgrades.register( upgrade );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static void registerPeripheralProvider( IPeripheralProvider provider )
 | 
			
		||||
    {
 | 
			
		||||
        Peripherals.register( provider );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static void registerBundledRedstoneProvider( IBundledRedstoneProvider provider )
 | 
			
		||||
    {
 | 
			
		||||
        BundledRedstone.register( provider );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static void registerMediaProvider( IMediaProvider provider )
 | 
			
		||||
    {
 | 
			
		||||
        MediaProviders.register( provider );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static void registerAPIFactory( ILuaAPIFactory factory )
 | 
			
		||||
    {
 | 
			
		||||
        ApiFactories.register( factory );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static IWiredNode createWiredNodeForElement( IWiredElement element )
 | 
			
		||||
    {
 | 
			
		||||
        return new WiredNode( element );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static IWiredElement getWiredElementAt( IBlockAccess world, BlockPos pos, EnumFacing side )
 | 
			
		||||
    {
 | 
			
		||||
        TileEntity tile = world.getTileEntity( pos );
 | 
			
		||||
        return tile != null && tile.hasCapability( CapabilityWiredElement.CAPABILITY, side )
 | 
			
		||||
            ? tile.getCapability( CapabilityWiredElement.CAPABILITY, side )
 | 
			
		||||
            : null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static int getDefaultBundledRedstoneOutput( World world, BlockPos pos, EnumFacing side )
 | 
			
		||||
    {
 | 
			
		||||
        return BundledRedstone.getDefaultOutput( world, pos, side );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static IPacketNetwork getWirelessNetwork()
 | 
			
		||||
    {
 | 
			
		||||
        return WirelessNetwork.getUniversal();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static int createUniqueNumberedSaveDir( World world, String parentSubPath )
 | 
			
		||||
    {
 | 
			
		||||
        return IDAssigner.getNextIDFromDirectory( parentSubPath );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static IWritableMount createSaveDirMount( World world, String subPath, long capacity )
 | 
			
		||||
    {
 | 
			
		||||
        try
 | 
			
		||||
        {
 | 
			
		||||
            return new FileMount( new File( getWorldDir(), subPath ), capacity );
 | 
			
		||||
        }
 | 
			
		||||
        catch( Exception e )
 | 
			
		||||
        {
 | 
			
		||||
            return null;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static void loadFromFile( List<IMount> mounts, File file, String path, boolean allowMissing )
 | 
			
		||||
    {
 | 
			
		||||
        try
 | 
			
		||||
        {
 | 
			
		||||
            if( file.isFile() )
 | 
			
		||||
            {
 | 
			
		||||
                mounts.add( new JarMount( file, path ) );
 | 
			
		||||
            }
 | 
			
		||||
            else
 | 
			
		||||
            {
 | 
			
		||||
                File subResource = new File( file, path );
 | 
			
		||||
                if( subResource.exists() ) mounts.add( new FileMount( subResource, 0 ) );
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
        catch( IOException | RuntimeException e )
 | 
			
		||||
        {
 | 
			
		||||
            if( allowMissing && e instanceof FileNotFoundException ) return;
 | 
			
		||||
            ComputerCraft.log.error( "Could not load mount '" + path + " 'from '" + file.getName() + "'", e );
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static IMount createResourceMount( Class<?> modClass, String domain, String subPath )
 | 
			
		||||
    {
 | 
			
		||||
        // Start building list of mounts
 | 
			
		||||
        List<IMount> mounts = new ArrayList<>();
 | 
			
		||||
        subPath = "assets/" + domain + "/" + subPath;
 | 
			
		||||
 | 
			
		||||
        // Mount from debug dir
 | 
			
		||||
        File codeDir = getDebugCodeDir( modClass );
 | 
			
		||||
        if( codeDir != null )
 | 
			
		||||
        {
 | 
			
		||||
            File subResource = new File( codeDir, subPath );
 | 
			
		||||
            if( subResource.exists() )
 | 
			
		||||
            {
 | 
			
		||||
                IMount resourcePackMount = new FileMount( subResource, 0 );
 | 
			
		||||
                mounts.add( resourcePackMount );
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Mount from mod jars, preferring the specified one.
 | 
			
		||||
        File modJar = getContainingJar( modClass );
 | 
			
		||||
        Set<File> otherMods = new HashSet<>();
 | 
			
		||||
        for( ModContainer container : Loader.instance().getActiveModList() )
 | 
			
		||||
        {
 | 
			
		||||
            File modFile = container.getSource();
 | 
			
		||||
            if( modFile != null && !modFile.equals( modJar ) && modFile.exists() )
 | 
			
		||||
            {
 | 
			
		||||
                otherMods.add( container.getSource() );
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        for( File file : otherMods )
 | 
			
		||||
        {
 | 
			
		||||
            loadFromFile( mounts, file, subPath, true );
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if( modJar != null )
 | 
			
		||||
        {
 | 
			
		||||
            loadFromFile( mounts, modJar, subPath, false );
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Mount from resource packs
 | 
			
		||||
        File resourcePackDir = getResourcePackDir();
 | 
			
		||||
        if( resourcePackDir.exists() && resourcePackDir.isDirectory() )
 | 
			
		||||
        {
 | 
			
		||||
            String[] resourcePacks = resourcePackDir.list();
 | 
			
		||||
            for( String resourcePackName : resourcePacks )
 | 
			
		||||
            {
 | 
			
		||||
                File resourcePack = new File( resourcePackDir, resourcePackName );
 | 
			
		||||
                loadFromFile( mounts, resourcePack, subPath, true );
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Return the combination of all the mounts found
 | 
			
		||||
        if( mounts.size() >= 2 )
 | 
			
		||||
        {
 | 
			
		||||
            IMount[] mountArray = new IMount[mounts.size()];
 | 
			
		||||
            mounts.toArray( mountArray );
 | 
			
		||||
            return new ComboMount( mountArray );
 | 
			
		||||
        }
 | 
			
		||||
        else if( mounts.size() == 1 )
 | 
			
		||||
        {
 | 
			
		||||
            return mounts.get( 0 );
 | 
			
		||||
        }
 | 
			
		||||
        else
 | 
			
		||||
        {
 | 
			
		||||
            return null;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static InputStream getResourceFile( Class<?> modClass, String domain, String subPath )
 | 
			
		||||
    {
 | 
			
		||||
        // Start searching in possible locations
 | 
			
		||||
        subPath = "assets/" + domain + "/" + subPath;
 | 
			
		||||
 | 
			
		||||
        // Look in resource packs
 | 
			
		||||
        File resourcePackDir = getResourcePackDir();
 | 
			
		||||
        if( resourcePackDir.exists() && resourcePackDir.isDirectory() )
 | 
			
		||||
        {
 | 
			
		||||
            String[] resourcePacks = resourcePackDir.list();
 | 
			
		||||
            for( String resourcePackPath : resourcePacks )
 | 
			
		||||
            {
 | 
			
		||||
                File resourcePack = new File( resourcePackDir, resourcePackPath );
 | 
			
		||||
                if( resourcePack.isDirectory() )
 | 
			
		||||
                {
 | 
			
		||||
                    // Mount a resource pack from a folder
 | 
			
		||||
                    File subResource = new File( resourcePack, subPath );
 | 
			
		||||
                    if( subResource.exists() && subResource.isFile() )
 | 
			
		||||
                    {
 | 
			
		||||
                        try
 | 
			
		||||
                        {
 | 
			
		||||
                            return new FileInputStream( subResource );
 | 
			
		||||
                        }
 | 
			
		||||
                        catch( FileNotFoundException ignored )
 | 
			
		||||
                        {
 | 
			
		||||
                        }
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
                else
 | 
			
		||||
                {
 | 
			
		||||
                    ZipFile zipFile = null;
 | 
			
		||||
                    try
 | 
			
		||||
                    {
 | 
			
		||||
                        final ZipFile zip = zipFile = new ZipFile( resourcePack );
 | 
			
		||||
                        ZipEntry entry = zipFile.getEntry( subPath );
 | 
			
		||||
                        if( entry != null )
 | 
			
		||||
                        {
 | 
			
		||||
                            // Return a custom InputStream which will close the original zip when finished.
 | 
			
		||||
                            return new FilterInputStream( zipFile.getInputStream( entry ) )
 | 
			
		||||
                            {
 | 
			
		||||
                                @Override
 | 
			
		||||
                                public void close() throws IOException
 | 
			
		||||
                                {
 | 
			
		||||
                                    super.close();
 | 
			
		||||
                                    zip.close();
 | 
			
		||||
                                }
 | 
			
		||||
                            };
 | 
			
		||||
                        }
 | 
			
		||||
                        else
 | 
			
		||||
                        {
 | 
			
		||||
                            IoUtil.closeQuietly( zipFile );
 | 
			
		||||
                        }
 | 
			
		||||
                    }
 | 
			
		||||
                    catch( IOException e )
 | 
			
		||||
                    {
 | 
			
		||||
                        IoUtil.closeQuietly( zipFile );
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Look in debug dir
 | 
			
		||||
        File codeDir = getDebugCodeDir( modClass );
 | 
			
		||||
        if( codeDir != null )
 | 
			
		||||
        {
 | 
			
		||||
            File subResource = new File( codeDir, subPath );
 | 
			
		||||
            if( subResource.exists() && subResource.isFile() )
 | 
			
		||||
            {
 | 
			
		||||
                try
 | 
			
		||||
                {
 | 
			
		||||
                    return new FileInputStream( subResource );
 | 
			
		||||
                }
 | 
			
		||||
                catch( FileNotFoundException ignored )
 | 
			
		||||
                {
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Look in class loader
 | 
			
		||||
        return modClass.getClassLoader().getResourceAsStream( subPath );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static File getContainingJar( Class<?> modClass )
 | 
			
		||||
    {
 | 
			
		||||
        String path = modClass.getProtectionDomain().getCodeSource().getLocation().getPath();
 | 
			
		||||
        int bangIndex = path.indexOf( '!' );
 | 
			
		||||
        if( bangIndex >= 0 )
 | 
			
		||||
        {
 | 
			
		||||
            path = path.substring( 0, bangIndex );
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        URL url;
 | 
			
		||||
        try
 | 
			
		||||
        {
 | 
			
		||||
            url = new URL( path );
 | 
			
		||||
        }
 | 
			
		||||
        catch( MalformedURLException e1 )
 | 
			
		||||
        {
 | 
			
		||||
            return null;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        File file;
 | 
			
		||||
        try
 | 
			
		||||
        {
 | 
			
		||||
            file = new File( url.toURI() );
 | 
			
		||||
        }
 | 
			
		||||
        catch( URISyntaxException e )
 | 
			
		||||
        {
 | 
			
		||||
            file = new File( url.getPath() );
 | 
			
		||||
        }
 | 
			
		||||
        return file;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static File getDebugCodeDir( Class<?> modClass )
 | 
			
		||||
    {
 | 
			
		||||
        String path = modClass.getProtectionDomain().getCodeSource().getLocation().getPath();
 | 
			
		||||
        int bangIndex = path.indexOf( '!' );
 | 
			
		||||
        return bangIndex >= 0 ? null : new File( new File( path ).getParentFile(), "../.." );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static void registerTurtleUpgrade( ITurtleUpgrade upgrade )
 | 
			
		||||
    {
 | 
			
		||||
        dan200.computercraft.shared.TurtleUpgrades.register( upgrade );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static File getWorldDir()
 | 
			
		||||
    {
 | 
			
		||||
        return DimensionManager.getCurrentSaveRootDirectory();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    //region Compatibility
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static File getWorldDir( World world )
 | 
			
		||||
    {
 | 
			
		||||
        return DimensionManager.getCurrentSaveRootDirectory();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static IMedia getMedia( ItemStack stack )
 | 
			
		||||
    {
 | 
			
		||||
        return MediaProviders.get( stack );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static IPocketUpgrade getPocketUpgrade( ItemStack stack )
 | 
			
		||||
    {
 | 
			
		||||
        return dan200.computercraft.shared.PocketUpgrades.get( stack );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static ITurtleUpgrade getTurtleUpgrade( ItemStack stack )
 | 
			
		||||
    {
 | 
			
		||||
        return dan200.computercraft.shared.TurtleUpgrades.get( stack );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static IPocketUpgrade getPocketUpgrade( String id )
 | 
			
		||||
    {
 | 
			
		||||
        return dan200.computercraft.shared.PocketUpgrades.get( id );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static ITurtleUpgrade getTurtleUpgrade( String id )
 | 
			
		||||
    {
 | 
			
		||||
        return dan200.computercraft.shared.TurtleUpgrades.get( id );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static IPeripheral getPeripheralAt( World world, BlockPos pos, EnumFacing side )
 | 
			
		||||
    {
 | 
			
		||||
        return Peripherals.getPeripheral( world, pos, side );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static boolean canPlayerUseCommands( EntityPlayer player )
 | 
			
		||||
    {
 | 
			
		||||
        MinecraftServer server = player.getServer();
 | 
			
		||||
        return server != null && server.getPlayerList().canSendCommands( player.getGameProfile() );
 | 
			
		||||
    }
 | 
			
		||||
    //endregion
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										174
									
								
								src/main/java/dan200/computercraft/ComputerCraftAPIImpl.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										174
									
								
								src/main/java/dan200/computercraft/ComputerCraftAPIImpl.java
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,174 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of ComputerCraft - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. Do not distribute without permission.
 | 
			
		||||
 * Send enquiries to dratcliffe@gmail.com
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft;
 | 
			
		||||
 | 
			
		||||
import java.io.File;
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
import java.io.InputStream;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI.IComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.api.filesystem.IMount;
 | 
			
		||||
import dan200.computercraft.api.filesystem.IWritableMount;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaAPIFactory;
 | 
			
		||||
import dan200.computercraft.api.media.IMediaProvider;
 | 
			
		||||
import dan200.computercraft.api.network.IPacketNetwork;
 | 
			
		||||
import dan200.computercraft.api.network.wired.IWiredElement;
 | 
			
		||||
import dan200.computercraft.api.network.wired.IWiredNode;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheralProvider;
 | 
			
		||||
import dan200.computercraft.api.pocket.IPocketUpgrade;
 | 
			
		||||
import dan200.computercraft.api.redstone.IBundledRedstoneProvider;
 | 
			
		||||
import dan200.computercraft.api.turtle.ITurtleUpgrade;
 | 
			
		||||
import dan200.computercraft.core.apis.ApiFactories;
 | 
			
		||||
import dan200.computercraft.core.filesystem.FileMount;
 | 
			
		||||
import dan200.computercraft.core.filesystem.ResourceMount;
 | 
			
		||||
import dan200.computercraft.mixin.MinecraftServerAccess;
 | 
			
		||||
import dan200.computercraft.shared.BundledRedstone;
 | 
			
		||||
import dan200.computercraft.shared.MediaProviders;
 | 
			
		||||
import dan200.computercraft.shared.Peripherals;
 | 
			
		||||
import dan200.computercraft.shared.PocketUpgrades;
 | 
			
		||||
import dan200.computercraft.shared.TurtleUpgrades;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.modem.wired.TileCable;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.modem.wired.TileWiredModemFull;
 | 
			
		||||
import dan200.computercraft.shared.peripheral.modem.wireless.WirelessNetwork;
 | 
			
		||||
import dan200.computercraft.shared.util.IDAssigner;
 | 
			
		||||
import dan200.computercraft.shared.wired.WiredNode;
 | 
			
		||||
import me.shedaniel.cloth.api.utils.v1.GameInstanceUtils;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.block.entity.BlockEntity;
 | 
			
		||||
import net.minecraft.resource.ReloadableResourceManager;
 | 
			
		||||
import net.minecraft.server.MinecraftServer;
 | 
			
		||||
import net.minecraft.util.Identifier;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.util.math.Direction;
 | 
			
		||||
import net.minecraft.world.BlockView;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import net.fabricmc.loader.api.FabricLoader;
 | 
			
		||||
 | 
			
		||||
public final class ComputerCraftAPIImpl implements IComputerCraftAPI {
 | 
			
		||||
    public static final ComputerCraftAPIImpl INSTANCE = new ComputerCraftAPIImpl();
 | 
			
		||||
 | 
			
		||||
    private String version;
 | 
			
		||||
 | 
			
		||||
    private ComputerCraftAPIImpl() {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static InputStream getResourceFile(String domain, String subPath) {
 | 
			
		||||
        MinecraftServer server = GameInstanceUtils.getServer();
 | 
			
		||||
        if (server != null) {
 | 
			
		||||
            ReloadableResourceManager manager = (ReloadableResourceManager) ((MinecraftServerAccess)server).getServerResourceManager().getResourceManager();
 | 
			
		||||
            try {
 | 
			
		||||
                return manager.getResource(new Identifier(domain, subPath))
 | 
			
		||||
                              .getInputStream();
 | 
			
		||||
            } catch (IOException ignored) {
 | 
			
		||||
                return null;
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public String getInstalledVersion() {
 | 
			
		||||
        if (this.version != null) {
 | 
			
		||||
            return this.version;
 | 
			
		||||
        }
 | 
			
		||||
        return this.version = FabricLoader.getInstance()
 | 
			
		||||
                                          .getModContainer(ComputerCraft.MOD_ID)
 | 
			
		||||
                                          .map(x -> x.getMetadata()
 | 
			
		||||
                                                .getVersion()
 | 
			
		||||
                                                .toString())
 | 
			
		||||
                                          .orElse("unknown");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public int createUniqueNumberedSaveDir(@Nonnull World world, @Nonnull String parentSubPath) {
 | 
			
		||||
        return IDAssigner.getNextId(parentSubPath);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public IWritableMount createSaveDirMount(@Nonnull World world, @Nonnull String subPath, long capacity) {
 | 
			
		||||
        try {
 | 
			
		||||
            return new FileMount(new File(IDAssigner.getDir(), subPath), capacity);
 | 
			
		||||
        } catch (Exception e) {
 | 
			
		||||
            return null;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public IMount createResourceMount(@Nonnull String domain, @Nonnull String subPath) {
 | 
			
		||||
        MinecraftServer server = GameInstanceUtils.getServer();
 | 
			
		||||
        if (server != null) {
 | 
			
		||||
            ReloadableResourceManager manager = (ReloadableResourceManager) ((MinecraftServerAccess)server).getServerResourceManager().getResourceManager();
 | 
			
		||||
            ResourceMount mount = ResourceMount.get(domain, subPath, manager);
 | 
			
		||||
            return mount.exists("") ? mount : null;
 | 
			
		||||
        }
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void registerPeripheralProvider(@Nonnull IPeripheralProvider provider) {
 | 
			
		||||
        Peripherals.register(provider);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void registerTurtleUpgrade(@Nonnull ITurtleUpgrade upgrade) {
 | 
			
		||||
        TurtleUpgrades.register(upgrade);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void registerBundledRedstoneProvider(@Nonnull IBundledRedstoneProvider provider) {
 | 
			
		||||
        BundledRedstone.register(provider);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public int getBundledRedstoneOutput(@Nonnull World world, @Nonnull BlockPos pos, @Nonnull Direction side) {
 | 
			
		||||
        return BundledRedstone.getDefaultOutput(world, pos, side);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void registerMediaProvider(@Nonnull IMediaProvider provider) {
 | 
			
		||||
        MediaProviders.register(provider);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void registerPocketUpgrade(@Nonnull IPocketUpgrade upgrade) {
 | 
			
		||||
        PocketUpgrades.register(upgrade);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public IPacketNetwork getWirelessNetwork() {
 | 
			
		||||
        return WirelessNetwork.getUniversal();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void registerAPIFactory(@Nonnull ILuaAPIFactory factory) {
 | 
			
		||||
        ApiFactories.register(factory);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public IWiredNode createWiredNodeForElement(@Nonnull IWiredElement element) {
 | 
			
		||||
        return new WiredNode(element);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nullable
 | 
			
		||||
    @Override
 | 
			
		||||
    public IWiredElement getWiredElementAt(@Nonnull BlockView world, @Nonnull BlockPos pos, @Nonnull Direction side) {
 | 
			
		||||
        BlockEntity tile = world.getBlockEntity(pos);
 | 
			
		||||
        if (tile instanceof TileCable) {
 | 
			
		||||
            return ((TileCable) tile).getElement(side);
 | 
			
		||||
        } else if (tile instanceof TileWiredModemFull) {
 | 
			
		||||
            return ((TileWiredModemFull) tile).getElement();
 | 
			
		||||
        }
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -1,97 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.turtle.ITurtleUpgrade;
 | 
			
		||||
import dan200.computercraft.api.turtle.TurtleUpgradeType;
 | 
			
		||||
import net.minecraft.block.Block;
 | 
			
		||||
import net.minecraft.item.Item;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.ResourceLocation;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A base class for {@link ITurtleUpgrade}s.
 | 
			
		||||
 *
 | 
			
		||||
 * One does not have to use this, but it does provide a convenient template.
 | 
			
		||||
 */
 | 
			
		||||
public abstract class AbstractTurtleUpgrade implements ITurtleUpgrade
 | 
			
		||||
{
 | 
			
		||||
    private final ResourceLocation id;
 | 
			
		||||
    private final int legacyId;
 | 
			
		||||
    private final TurtleUpgradeType type;
 | 
			
		||||
    private final String adjective;
 | 
			
		||||
    private final ItemStack stack;
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade( ResourceLocation id, int legacyId, TurtleUpgradeType type, String adjective, ItemStack stack )
 | 
			
		||||
    {
 | 
			
		||||
        this.id = id;
 | 
			
		||||
        this.legacyId = legacyId;
 | 
			
		||||
        this.type = type;
 | 
			
		||||
        this.adjective = adjective;
 | 
			
		||||
        this.stack = stack;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade( ResourceLocation id, int legacyId, TurtleUpgradeType type, String adjective, Item item )
 | 
			
		||||
    {
 | 
			
		||||
        this( id, legacyId, type, adjective, new ItemStack( item ) );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade( ResourceLocation id, int legacyId, TurtleUpgradeType type, String adjective, Block block )
 | 
			
		||||
    {
 | 
			
		||||
        this( id, legacyId, type, adjective, new ItemStack( block ) );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade( ResourceLocation id, int legacyId, TurtleUpgradeType type, ItemStack stack )
 | 
			
		||||
    {
 | 
			
		||||
        this( id, legacyId, type, "upgrade." + id + ".adjective", stack );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade( ResourceLocation id, int legacyId, TurtleUpgradeType type, Item item )
 | 
			
		||||
    {
 | 
			
		||||
        this( id, legacyId, type, new ItemStack( item ) );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade( ResourceLocation id, int legacyId, TurtleUpgradeType type, Block block )
 | 
			
		||||
    {
 | 
			
		||||
        this( id, legacyId, type, new ItemStack( block ) );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final ResourceLocation getUpgradeID()
 | 
			
		||||
    {
 | 
			
		||||
        return id;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public final int getLegacyUpgradeID()
 | 
			
		||||
    {
 | 
			
		||||
        return legacyId;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final String getUnlocalisedAdjective()
 | 
			
		||||
    {
 | 
			
		||||
        return adjective;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final TurtleUpgradeType getType()
 | 
			
		||||
    {
 | 
			
		||||
        return type;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final ItemStack getCraftingItem()
 | 
			
		||||
    {
 | 
			
		||||
        return stack;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -3,8 +3,12 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.filesystem.IMount;
 | 
			
		||||
import dan200.computercraft.api.filesystem.IWritableMount;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaAPIFactory;
 | 
			
		||||
@@ -16,55 +20,47 @@ import dan200.computercraft.api.network.wired.IWiredNode;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheralProvider;
 | 
			
		||||
import dan200.computercraft.api.permissions.ITurtlePermissionProvider;
 | 
			
		||||
import dan200.computercraft.api.pocket.IPocketUpgrade;
 | 
			
		||||
import dan200.computercraft.api.redstone.IBundledRedstoneProvider;
 | 
			
		||||
import dan200.computercraft.api.turtle.ITurtleUpgrade;
 | 
			
		||||
import net.minecraft.util.EnumFacing;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.world.IBlockAccess;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.lang.reflect.Method;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.util.math.Direction;
 | 
			
		||||
import net.minecraft.world.BlockView;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The static entry point to the ComputerCraft API.
 | 
			
		||||
 *
 | 
			
		||||
 * Members in this class must be called after mod_ComputerCraft has been initialised, but may be called before it is
 | 
			
		||||
 * fully loaded.
 | 
			
		||||
 * Members in this class must be called after mod_ComputerCraft has been initialised, but may be called before it is fully loaded.
 | 
			
		||||
 */
 | 
			
		||||
public final class ComputerCraftAPI
 | 
			
		||||
{
 | 
			
		||||
    public static boolean isInstalled()
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        return computerCraft != null;
 | 
			
		||||
public final class ComputerCraftAPI {
 | 
			
		||||
    private static IComputerCraftAPI instance;
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static String getAPIVersion() {
 | 
			
		||||
        return getInstalledVersion();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static String getInstalledVersion()
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_getVersion != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                return (String) computerCraft_getVersion.invoke( null );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
    public static String getInstalledVersion() {
 | 
			
		||||
        return getInstance().getInstalledVersion();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    private static IComputerCraftAPI getInstance() {
 | 
			
		||||
        if (instance != null) {
 | 
			
		||||
            return instance;
 | 
			
		||||
        }
 | 
			
		||||
        return "";
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static String getAPIVersion()
 | 
			
		||||
    {
 | 
			
		||||
        return "${version}";
 | 
			
		||||
        try {
 | 
			
		||||
            return instance = (IComputerCraftAPI) Class.forName("dan200.computercraft.ComputerCraftAPIImpl")
 | 
			
		||||
                                                       .getField("INSTANCE")
 | 
			
		||||
                                                       .get(null);
 | 
			
		||||
        } catch (ReflectiveOperationException e) {
 | 
			
		||||
            throw new IllegalStateException("Cannot find ComputerCraft API", e);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -72,43 +68,29 @@ public final class ComputerCraftAPI
 | 
			
		||||
     *
 | 
			
		||||
     * Use in conjunction with createSaveDirMount() to create a unique place for your peripherals or media items to store files.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world         The world for which the save dir should be created. This should be the server side world object.
 | 
			
		||||
     * @param world The world for which the save dir should be created. This should be the server side world object.
 | 
			
		||||
     * @param parentSubPath The folder path within the save directory where the new directory should be created. eg: "computercraft/disk"
 | 
			
		||||
     * @return The numerical value of the name of the new folder, or -1 if the folder could not be created for some reason.
 | 
			
		||||
     *
 | 
			
		||||
     * eg: if createUniqueNumberedSaveDir( world, "computer/disk" ) was called returns 42, then "computer/disk/42" is now
 | 
			
		||||
     * available for writing.
 | 
			
		||||
     *     eg: if createUniqueNumberedSaveDir( world, "computer/disk" ) was called returns 42, then "computer/disk/42" is now available for writing.
 | 
			
		||||
     * @see #createSaveDirMount(World, String, long)
 | 
			
		||||
     */
 | 
			
		||||
    public static int createUniqueNumberedSaveDir( @Nonnull World world, @Nonnull String parentSubPath )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_createUniqueNumberedSaveDir != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                return (Integer) computerCraft_createUniqueNumberedSaveDir.invoke( null, world, parentSubPath );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
        return -1;
 | 
			
		||||
    public static int createUniqueNumberedSaveDir(@Nonnull World world, @Nonnull String parentSubPath) {
 | 
			
		||||
        return getInstance().createUniqueNumberedSaveDir(world, parentSubPath);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Creates a file system mount that maps to a subfolder of the save directory for a given world, and returns it.
 | 
			
		||||
     *
 | 
			
		||||
     * Use in conjunction with IComputerAccess.mount() or IComputerAccess.mountWritable() to mount a folder from the
 | 
			
		||||
     * users save directory onto a computers file system.
 | 
			
		||||
     * Use in conjunction with IComputerAccess.mount() or IComputerAccess.mountWritable() to mount a folder from the users save directory onto a computers
 | 
			
		||||
     * file system.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world    The world for which the save dir can be found. This should be the server side world object.
 | 
			
		||||
     * @param subPath  The folder path within the save directory that the mount should map to. eg: "computer/disk/42".
 | 
			
		||||
     *                 Use createUniqueNumberedSaveDir() to create a new numbered folder to use.
 | 
			
		||||
     * @param world The world for which the save dir can be found. This should be the server side world object.
 | 
			
		||||
     * @param subPath The folder path within the save directory that the mount should map to. eg: "computer/disk/42". Use createUniqueNumberedSaveDir()
 | 
			
		||||
     *     to create a new numbered folder to use.
 | 
			
		||||
     * @param capacity The amount of data that can be stored in the directory before it fills up, in bytes.
 | 
			
		||||
     * @return The mount, or null if it could be created for some reason. Use IComputerAccess.mount() or IComputerAccess.mountWritable()
 | 
			
		||||
     * to mount this on a Computers' file system.
 | 
			
		||||
     * @return The mount, or null if it could be created for some reason. Use IComputerAccess.mount() or IComputerAccess.mountWritable() to mount this on a
 | 
			
		||||
     *     Computers' file system.
 | 
			
		||||
     * @see #createUniqueNumberedSaveDir(World, String)
 | 
			
		||||
     * @see IComputerAccess#mount(String, IMount)
 | 
			
		||||
     * @see IComputerAccess#mountWritable(String, IWritableMount)
 | 
			
		||||
@@ -116,57 +98,28 @@ public final class ComputerCraftAPI
 | 
			
		||||
     * @see IWritableMount
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public static IWritableMount createSaveDirMount( @Nonnull World world, @Nonnull String subPath, long capacity )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_createSaveDirMount != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                return (IWritableMount) computerCraft_createSaveDirMount.invoke( null, world, subPath, capacity );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
        return null;
 | 
			
		||||
    public static IWritableMount createSaveDirMount(@Nonnull World world, @Nonnull String subPath, long capacity) {
 | 
			
		||||
        return getInstance().createSaveDirMount(world, subPath, capacity);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Creates a file system mount to a resource folder, and returns it.
 | 
			
		||||
     *
 | 
			
		||||
     * Use in conjunction with IComputerAccess.mount() or IComputerAccess.mountWritable() to mount a resource folder
 | 
			
		||||
     * onto a computer's file system.
 | 
			
		||||
     * Use in conjunction with {@link IComputerAccess#mount} or {@link IComputerAccess#mountWritable} to mount a resource folder onto a computer's file
 | 
			
		||||
     * system.
 | 
			
		||||
     *
 | 
			
		||||
     * The files in this mount will be a combination of files in the specified mod jar, and resource packs that contain
 | 
			
		||||
     * resources with the same domain and path.
 | 
			
		||||
     * The files in this mount will be a combination of files in all mod jar, and data packs that contain resources with the same domain and path.
 | 
			
		||||
     *
 | 
			
		||||
     * @param modClass A class in whose jar to look first for the resources to mount. Using your main mod class is recommended. eg: MyMod.class
 | 
			
		||||
     * @param domain   The domain under which to look for resources. eg: "mymod".
 | 
			
		||||
     * @param subPath  The domain under which to look for resources. eg: "mymod/lua/myfiles".
 | 
			
		||||
     * @return The mount, or {@code null} if it could be created for some reason. Use IComputerAccess.mount() or
 | 
			
		||||
     * IComputerAccess.mountWritable() to mount this on a Computers' file system.
 | 
			
		||||
     * @param domain The domain under which to look for resources. eg: "mymod".
 | 
			
		||||
     * @param subPath The subPath under which to look for resources. eg: "lua/myfiles".
 | 
			
		||||
     * @return The mount, or {@code null} if it could be created for some reason.
 | 
			
		||||
     * @see IComputerAccess#mount(String, IMount)
 | 
			
		||||
     * @see IComputerAccess#mountWritable(String, IWritableMount)
 | 
			
		||||
     * @see IMount
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public static IMount createResourceMount( @Nonnull Class<?> modClass, @Nonnull String domain, @Nonnull String subPath )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_createResourceMount != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                return (IMount) computerCraft_createResourceMount.invoke( null, modClass, domain, subPath );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
        return null;
 | 
			
		||||
    public static IMount createResourceMount(@Nonnull String domain, @Nonnull String subPath) {
 | 
			
		||||
        return getInstance().createResourceMount(domain, subPath);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -176,47 +129,19 @@ public final class ComputerCraftAPI
 | 
			
		||||
     * @see IPeripheral
 | 
			
		||||
     * @see IPeripheralProvider
 | 
			
		||||
     */
 | 
			
		||||
    public static void registerPeripheralProvider( @Nonnull IPeripheralProvider provider )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_registerPeripheralProvider != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                computerCraft_registerPeripheralProvider.invoke( null, provider );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    public static void registerPeripheralProvider(@Nonnull IPeripheralProvider provider) {
 | 
			
		||||
        getInstance().registerPeripheralProvider(provider);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Registers a new turtle turtle for use in ComputerCraft. After calling this,
 | 
			
		||||
     * users should be able to craft Turtles with your new turtle. It is recommended to call
 | 
			
		||||
     * this during the load() method of your mod.
 | 
			
		||||
     * Registers a new turtle turtle for use in ComputerCraft. After calling this, users should be able to craft Turtles with your new turtle. It is
 | 
			
		||||
     * recommended to call this during the load() method of your mod.
 | 
			
		||||
     *
 | 
			
		||||
     * @param upgrade The turtle upgrade to register.
 | 
			
		||||
     * @see ITurtleUpgrade
 | 
			
		||||
     */
 | 
			
		||||
    public static void registerTurtleUpgrade( @Nonnull ITurtleUpgrade upgrade )
 | 
			
		||||
    {
 | 
			
		||||
        if( upgrade != null )
 | 
			
		||||
        {
 | 
			
		||||
            findCC();
 | 
			
		||||
            if( computerCraft_registerTurtleUpgrade != null )
 | 
			
		||||
            {
 | 
			
		||||
                try
 | 
			
		||||
                {
 | 
			
		||||
                    computerCraft_registerTurtleUpgrade.invoke( null, upgrade );
 | 
			
		||||
                }
 | 
			
		||||
                catch( Exception e )
 | 
			
		||||
                {
 | 
			
		||||
                    // It failed
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    public static void registerTurtleUpgrade(@Nonnull ITurtleUpgrade upgrade) {
 | 
			
		||||
        getInstance().registerTurtleUpgrade(upgrade);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -225,47 +150,22 @@ public final class ComputerCraftAPI
 | 
			
		||||
     * @param provider The bundled redstone provider to register.
 | 
			
		||||
     * @see IBundledRedstoneProvider
 | 
			
		||||
     */
 | 
			
		||||
    public static void registerBundledRedstoneProvider( @Nonnull IBundledRedstoneProvider provider )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_registerBundledRedstoneProvider != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                computerCraft_registerBundledRedstoneProvider.invoke( null, provider );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    public static void registerBundledRedstoneProvider(@Nonnull IBundledRedstoneProvider provider) {
 | 
			
		||||
        getInstance().registerBundledRedstoneProvider(provider);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * If there is a Computer or Turtle at a certain position in the world, get it's bundled redstone output.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world The world this block is in.
 | 
			
		||||
     * @param pos   The position this block is at.
 | 
			
		||||
     * @param side  The side to extract the bundled redstone output from.
 | 
			
		||||
     * @return If there is a block capable of emitting bundled redstone at the location, it's signal (0-65535) will be returned.
 | 
			
		||||
     * If there is no block capable of emitting bundled redstone at the location, -1 will be returned.
 | 
			
		||||
     * @param pos The position this block is at.
 | 
			
		||||
     * @param side The side to extract the bundled redstone output from.
 | 
			
		||||
     * @return If there is a block capable of emitting bundled redstone at the location, it's signal (0-65535) will be returned. If there is no block
 | 
			
		||||
     *     capable of emitting bundled redstone at the location, -1 will be returned.
 | 
			
		||||
     * @see IBundledRedstoneProvider
 | 
			
		||||
     */
 | 
			
		||||
    public static int getBundledRedstoneOutput( @Nonnull World world, @Nonnull BlockPos pos, @Nonnull EnumFacing side )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_getDefaultBundledRedstoneOutput != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                return (Integer) computerCraft_getDefaultBundledRedstoneOutput.invoke( null, world, pos, side );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
        return -1;
 | 
			
		||||
    public static int getBundledRedstoneOutput(@Nonnull World world, @Nonnull BlockPos pos, @Nonnull Direction side) {
 | 
			
		||||
        return getInstance().getBundledRedstoneOutput(world, pos, side);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -274,60 +174,12 @@ public final class ComputerCraftAPI
 | 
			
		||||
     * @param provider The media provider to register.
 | 
			
		||||
     * @see IMediaProvider
 | 
			
		||||
     */
 | 
			
		||||
    public static void registerMediaProvider( @Nonnull IMediaProvider provider )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_registerMediaProvider != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                computerCraft_registerMediaProvider.invoke( null, provider );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    public static void registerMediaProvider(@Nonnull IMediaProvider provider) {
 | 
			
		||||
        getInstance().registerMediaProvider(provider);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Registers a permission provider to restrict where turtles can move or build.
 | 
			
		||||
     *
 | 
			
		||||
     * @param provider The turtle permission provider to register.
 | 
			
		||||
     * @see ITurtlePermissionProvider
 | 
			
		||||
     * @deprecated Prefer using {@link dan200.computercraft.api.turtle.event.TurtleBlockEvent} or the standard Forge events.
 | 
			
		||||
     */
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    public static void registerPermissionProvider( @Nonnull ITurtlePermissionProvider provider )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_registerPermissionProvider != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                computerCraft_registerPermissionProvider.invoke( null, provider );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static void registerPocketUpgrade( @Nonnull IPocketUpgrade upgrade )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_registerPocketUpgrade != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                computerCraft_registerPocketUpgrade.invoke( null, upgrade );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    public static void registerPocketUpgrade(@Nonnull IPocketUpgrade upgrade) {
 | 
			
		||||
        getInstance().registerPocketUpgrade(upgrade);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -335,38 +187,12 @@ public final class ComputerCraftAPI
 | 
			
		||||
     *
 | 
			
		||||
     * @return The global wireless network, or {@code null} if it could not be fetched.
 | 
			
		||||
     */
 | 
			
		||||
    public static IPacketNetwork getWirelessNetwork()
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_getWirelessNetwork != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                return (IPacketNetwork) computerCraft_getWirelessNetwork.invoke( null );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed;
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return null;
 | 
			
		||||
    public static IPacketNetwork getWirelessNetwork() {
 | 
			
		||||
        return getInstance().getWirelessNetwork();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static void registerAPIFactory( @Nonnull ILuaAPIFactory upgrade )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_registerAPIFactory != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                computerCraft_registerAPIFactory.invoke( null, upgrade );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                // It failed
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    public static void registerAPIFactory(@Nonnull ILuaAPIFactory factory) {
 | 
			
		||||
        getInstance().registerAPIFactory(factory);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -377,147 +203,57 @@ public final class ComputerCraftAPI
 | 
			
		||||
     * @see IWiredElement#getNode()
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static IWiredNode createWiredNodeForElement( @Nonnull IWiredElement element )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_createWiredNodeForElement != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                return (IWiredNode) computerCraft_createWiredNodeForElement.invoke( null, element );
 | 
			
		||||
            }
 | 
			
		||||
            catch( ReflectiveOperationException e )
 | 
			
		||||
            {
 | 
			
		||||
                throw new IllegalStateException( "Error creating wired node", e );
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
        else
 | 
			
		||||
        {
 | 
			
		||||
            throw new IllegalStateException( "ComputerCraft cannot be found" );
 | 
			
		||||
        }
 | 
			
		||||
    public static IWiredNode createWiredNodeForElement(@Nonnull IWiredElement element) {
 | 
			
		||||
        return getInstance().createWiredNodeForElement(element);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the wired network element for a block in world.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world The world the block exists in
 | 
			
		||||
     * @param pos   The position the block exists in
 | 
			
		||||
     * @param side  The side to extract the network element from
 | 
			
		||||
     * @param pos The position the block exists in
 | 
			
		||||
     * @param side The side to extract the network element from
 | 
			
		||||
     * @return The element's node
 | 
			
		||||
     * @see IWiredElement#getNode()
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public static IWiredElement getWiredElementAt( @Nonnull IBlockAccess world, @Nonnull BlockPos pos, @Nonnull EnumFacing side )
 | 
			
		||||
    {
 | 
			
		||||
        findCC();
 | 
			
		||||
        if( computerCraft_getWiredElementAt != null )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                return (IWiredElement) computerCraft_getWiredElementAt.invoke( null, world, pos, side );
 | 
			
		||||
            }
 | 
			
		||||
            catch( ReflectiveOperationException ignored )
 | 
			
		||||
            {
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return null;
 | 
			
		||||
    public static IWiredElement getWiredElementAt(@Nonnull BlockView world, @Nonnull BlockPos pos, @Nonnull Direction side) {
 | 
			
		||||
        return getInstance().getWiredElementAt(world, pos, side);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // The functions below here are private, and are used to interface with the non-API ComputerCraft classes.
 | 
			
		||||
    // Reflection is used here so you can develop your mod without decompiling ComputerCraft and including
 | 
			
		||||
    // it in your solution, and so your mod won't crash if ComputerCraft is installed.
 | 
			
		||||
    public interface IComputerCraftAPI {
 | 
			
		||||
        @Nonnull
 | 
			
		||||
        String getInstalledVersion();
 | 
			
		||||
 | 
			
		||||
    private static void findCC()
 | 
			
		||||
    {
 | 
			
		||||
        if( !ccSearched )
 | 
			
		||||
        {
 | 
			
		||||
            try
 | 
			
		||||
            {
 | 
			
		||||
                computerCraft = Class.forName( "dan200.computercraft.ComputerCraft" );
 | 
			
		||||
                computerCraft_getVersion = findCCMethod( "getVersion", new Class<?>[] {
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_createUniqueNumberedSaveDir = findCCMethod( "createUniqueNumberedSaveDir", new Class<?>[] {
 | 
			
		||||
                    World.class, String.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_createSaveDirMount = findCCMethod( "createSaveDirMount", new Class<?>[] {
 | 
			
		||||
                    World.class, String.class, Long.TYPE,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_createResourceMount = findCCMethod( "createResourceMount", new Class<?>[] {
 | 
			
		||||
                    Class.class, String.class, String.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_registerPeripheralProvider = findCCMethod( "registerPeripheralProvider", new Class<?>[] {
 | 
			
		||||
                    IPeripheralProvider.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_registerTurtleUpgrade = findCCMethod( "registerTurtleUpgrade", new Class<?>[] {
 | 
			
		||||
                    ITurtleUpgrade.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_registerBundledRedstoneProvider = findCCMethod( "registerBundledRedstoneProvider", new Class<?>[] {
 | 
			
		||||
                    IBundledRedstoneProvider.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_getDefaultBundledRedstoneOutput = findCCMethod( "getDefaultBundledRedstoneOutput", new Class<?>[] {
 | 
			
		||||
                    World.class, BlockPos.class, EnumFacing.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_registerMediaProvider = findCCMethod( "registerMediaProvider", new Class<?>[] {
 | 
			
		||||
                    IMediaProvider.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_registerPermissionProvider = findCCMethod( "registerPermissionProvider", new Class<?>[] {
 | 
			
		||||
                    ITurtlePermissionProvider.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_registerPocketUpgrade = findCCMethod( "registerPocketUpgrade", new Class<?>[] {
 | 
			
		||||
                    IPocketUpgrade.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_getWirelessNetwork = findCCMethod( "getWirelessNetwork", new Class<?>[] {
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_registerAPIFactory = findCCMethod( "registerAPIFactory", new Class<?>[] {
 | 
			
		||||
                    ILuaAPIFactory.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_createWiredNodeForElement = findCCMethod( "createWiredNodeForElement", new Class<?>[] {
 | 
			
		||||
                    IWiredElement.class,
 | 
			
		||||
                } );
 | 
			
		||||
                computerCraft_getWiredElementAt = findCCMethod( "getWiredElementAt", new Class<?>[] {
 | 
			
		||||
                    IBlockAccess.class, BlockPos.class, EnumFacing.class,
 | 
			
		||||
                } );
 | 
			
		||||
            }
 | 
			
		||||
            catch( Exception e )
 | 
			
		||||
            {
 | 
			
		||||
                System.err.println( "ComputerCraftAPI: ComputerCraft not found." );
 | 
			
		||||
            }
 | 
			
		||||
            finally
 | 
			
		||||
            {
 | 
			
		||||
                ccSearched = true;
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
        int createUniqueNumberedSaveDir(@Nonnull World world, @Nonnull String parentSubPath);
 | 
			
		||||
 | 
			
		||||
        @Nullable
 | 
			
		||||
        IWritableMount createSaveDirMount(@Nonnull World world, @Nonnull String subPath, long capacity);
 | 
			
		||||
 | 
			
		||||
        @Nullable
 | 
			
		||||
        IMount createResourceMount(@Nonnull String domain, @Nonnull String subPath);
 | 
			
		||||
 | 
			
		||||
        void registerPeripheralProvider(@Nonnull IPeripheralProvider provider);
 | 
			
		||||
 | 
			
		||||
        void registerTurtleUpgrade(@Nonnull ITurtleUpgrade upgrade);
 | 
			
		||||
 | 
			
		||||
        void registerBundledRedstoneProvider(@Nonnull IBundledRedstoneProvider provider);
 | 
			
		||||
 | 
			
		||||
        int getBundledRedstoneOutput(@Nonnull World world, @Nonnull BlockPos pos, @Nonnull Direction side);
 | 
			
		||||
 | 
			
		||||
        void registerMediaProvider(@Nonnull IMediaProvider provider);
 | 
			
		||||
 | 
			
		||||
        void registerPocketUpgrade(@Nonnull IPocketUpgrade upgrade);
 | 
			
		||||
 | 
			
		||||
        @Nonnull
 | 
			
		||||
        IPacketNetwork getWirelessNetwork();
 | 
			
		||||
 | 
			
		||||
        void registerAPIFactory(@Nonnull ILuaAPIFactory factory);
 | 
			
		||||
 | 
			
		||||
        @Nonnull
 | 
			
		||||
        IWiredNode createWiredNodeForElement(@Nonnull IWiredElement element);
 | 
			
		||||
 | 
			
		||||
        @Nullable
 | 
			
		||||
        IWiredElement getWiredElementAt(@Nonnull BlockView world, @Nonnull BlockPos pos, @Nonnull Direction side);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static Method findCCMethod( String name, Class<?>[] args )
 | 
			
		||||
    {
 | 
			
		||||
        try
 | 
			
		||||
        {
 | 
			
		||||
            return computerCraft != null ? computerCraft.getMethod( name, args ) : null;
 | 
			
		||||
        }
 | 
			
		||||
        catch( NoSuchMethodException e )
 | 
			
		||||
        {
 | 
			
		||||
            System.err.println( "ComputerCraftAPI: ComputerCraft method " + name + " not found." );
 | 
			
		||||
            return null;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static boolean ccSearched = false;
 | 
			
		||||
    private static Class<?> computerCraft = null;
 | 
			
		||||
    private static Method computerCraft_getVersion = null;
 | 
			
		||||
    private static Method computerCraft_createUniqueNumberedSaveDir = null;
 | 
			
		||||
    private static Method computerCraft_createSaveDirMount = null;
 | 
			
		||||
    private static Method computerCraft_createResourceMount = null;
 | 
			
		||||
    private static Method computerCraft_registerPeripheralProvider = null;
 | 
			
		||||
    private static Method computerCraft_registerTurtleUpgrade = null;
 | 
			
		||||
    private static Method computerCraft_registerBundledRedstoneProvider = null;
 | 
			
		||||
    private static Method computerCraft_getDefaultBundledRedstoneOutput = null;
 | 
			
		||||
    private static Method computerCraft_registerMediaProvider = null;
 | 
			
		||||
    private static Method computerCraft_registerPermissionProvider = null;
 | 
			
		||||
    private static Method computerCraft_registerPocketUpgrade = null;
 | 
			
		||||
    private static Method computerCraft_getWirelessNetwork = null;
 | 
			
		||||
    private static Method computerCraft_registerAPIFactory = null;
 | 
			
		||||
    private static Method computerCraft_createWiredNodeForElement = null;
 | 
			
		||||
    private static Method computerCraft_getWiredElementAt = null;
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,83 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.client;
 | 
			
		||||
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.mixin.AffineTransformationAccess;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.client.MinecraftClient;
 | 
			
		||||
import net.minecraft.client.render.model.BakedModel;
 | 
			
		||||
import net.minecraft.client.render.model.BakedModelManager;
 | 
			
		||||
import net.minecraft.client.util.ModelIdentifier;
 | 
			
		||||
import net.minecraft.client.util.math.AffineTransformation;
 | 
			
		||||
import net.minecraft.client.util.math.MatrixStack;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
 | 
			
		||||
import net.fabricmc.api.EnvType;
 | 
			
		||||
import net.fabricmc.api.Environment;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A model to render, combined with a transformation matrix to apply.
 | 
			
		||||
 */
 | 
			
		||||
@Environment (EnvType.CLIENT)
 | 
			
		||||
public final class TransformedModel {
 | 
			
		||||
    private final BakedModel model;
 | 
			
		||||
    private final AffineTransformation matrix;
 | 
			
		||||
 | 
			
		||||
    public TransformedModel(@Nonnull BakedModel model, @Nonnull AffineTransformation matrix) {
 | 
			
		||||
        this.model = Objects.requireNonNull(model);
 | 
			
		||||
        this.matrix = Objects.requireNonNull(matrix);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public TransformedModel(@Nonnull BakedModel model) {
 | 
			
		||||
        this.model = Objects.requireNonNull(model);
 | 
			
		||||
        this.matrix = AffineTransformation.identity();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static TransformedModel of(@Nonnull ModelIdentifier location) {
 | 
			
		||||
        BakedModelManager modelManager = MinecraftClient.getInstance()
 | 
			
		||||
                                                        .getBakedModelManager();
 | 
			
		||||
        return new TransformedModel(modelManager.getModel(location));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static TransformedModel of(@Nonnull ItemStack item, @Nonnull AffineTransformation transform) {
 | 
			
		||||
        BakedModel model = MinecraftClient.getInstance()
 | 
			
		||||
                                          .getItemRenderer()
 | 
			
		||||
                                          .getModels()
 | 
			
		||||
                                          .getModel(item);
 | 
			
		||||
        return new TransformedModel(model, transform);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public BakedModel getModel() {
 | 
			
		||||
        return this.model;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public AffineTransformation getMatrix() {
 | 
			
		||||
        return this.matrix;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void push(MatrixStack matrixStack) {
 | 
			
		||||
        matrixStack.push();
 | 
			
		||||
 | 
			
		||||
        AffineTransformationAccess access = (AffineTransformationAccess) (Object) this.matrix;
 | 
			
		||||
        if (access.getTranslation() != null)
 | 
			
		||||
            matrixStack.translate(access.getTranslation().getX(), access.getTranslation().getY(), access.getTranslation().getZ());
 | 
			
		||||
 | 
			
		||||
        matrixStack.multiply(this.matrix.getRotation2());
 | 
			
		||||
 | 
			
		||||
        if (access.getScale() != null)
 | 
			
		||||
            matrixStack.scale(access.getScale().getX(), access.getScale().getY(), access.getScale().getZ());
 | 
			
		||||
 | 
			
		||||
        if (access.getRotation1() != null)
 | 
			
		||||
            matrixStack.multiply(access.getRotation1());
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -3,6 +3,7 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.filesystem;
 | 
			
		||||
 | 
			
		||||
import java.nio.file.attribute.BasicFileAttributes;
 | 
			
		||||
@@ -12,70 +13,59 @@ import java.time.Instant;
 | 
			
		||||
/**
 | 
			
		||||
 * A simple version of {@link BasicFileAttributes}, which provides what information a {@link IMount} already exposes.
 | 
			
		||||
 */
 | 
			
		||||
final class FileAttributes implements BasicFileAttributes
 | 
			
		||||
{
 | 
			
		||||
    private static final FileTime EPOCH = FileTime.from( Instant.EPOCH );
 | 
			
		||||
final class FileAttributes implements BasicFileAttributes {
 | 
			
		||||
    private static final FileTime EPOCH = FileTime.from(Instant.EPOCH);
 | 
			
		||||
 | 
			
		||||
    private final boolean isDirectory;
 | 
			
		||||
    private final long size;
 | 
			
		||||
 | 
			
		||||
    FileAttributes( boolean isDirectory, long size )
 | 
			
		||||
    {
 | 
			
		||||
    FileAttributes(boolean isDirectory, long size) {
 | 
			
		||||
        this.isDirectory = isDirectory;
 | 
			
		||||
        this.size = size;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public FileTime lastModifiedTime()
 | 
			
		||||
    {
 | 
			
		||||
    public FileTime lastModifiedTime() {
 | 
			
		||||
        return EPOCH;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public FileTime lastAccessTime()
 | 
			
		||||
    {
 | 
			
		||||
    public FileTime lastAccessTime() {
 | 
			
		||||
        return EPOCH;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public FileTime creationTime()
 | 
			
		||||
    {
 | 
			
		||||
    public FileTime creationTime() {
 | 
			
		||||
        return EPOCH;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public boolean isRegularFile()
 | 
			
		||||
    {
 | 
			
		||||
        return !isDirectory;
 | 
			
		||||
    public boolean isRegularFile() {
 | 
			
		||||
        return !this.isDirectory;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public boolean isDirectory()
 | 
			
		||||
    {
 | 
			
		||||
        return isDirectory;
 | 
			
		||||
    public boolean isDirectory() {
 | 
			
		||||
        return this.isDirectory;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public boolean isSymbolicLink()
 | 
			
		||||
    {
 | 
			
		||||
    public boolean isSymbolicLink() {
 | 
			
		||||
        return false;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public boolean isOther()
 | 
			
		||||
    {
 | 
			
		||||
    public boolean isOther() {
 | 
			
		||||
        return false;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public long size()
 | 
			
		||||
    {
 | 
			
		||||
        return size;
 | 
			
		||||
    public long size() {
 | 
			
		||||
        return this.size;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public Object fileKey()
 | 
			
		||||
    {
 | 
			
		||||
    public Object fileKey() {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,39 +3,37 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.filesystem;
 | 
			
		||||
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An {@link IOException} which occurred on a specific file.
 | 
			
		||||
 *
 | 
			
		||||
 * This may be thrown from a {@link IMount} or {@link IWritableMount} to give more information about a failure.
 | 
			
		||||
 */
 | 
			
		||||
public class FileOperationException extends IOException
 | 
			
		||||
{
 | 
			
		||||
public class FileOperationException extends IOException {
 | 
			
		||||
    private static final long serialVersionUID = -8809108200853029849L;
 | 
			
		||||
 | 
			
		||||
    private final String filename;
 | 
			
		||||
 | 
			
		||||
    public FileOperationException( @Nullable String filename, @Nonnull String message )
 | 
			
		||||
    {
 | 
			
		||||
        super( Objects.requireNonNull( message, "message cannot be null" ) );
 | 
			
		||||
    public FileOperationException(@Nullable String filename, @Nonnull String message) {
 | 
			
		||||
        super(Objects.requireNonNull(message, "message cannot be null"));
 | 
			
		||||
        this.filename = filename;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public FileOperationException( @Nonnull String message )
 | 
			
		||||
    {
 | 
			
		||||
        super( Objects.requireNonNull( message, "message cannot be null" ) );
 | 
			
		||||
    public FileOperationException(@Nonnull String message) {
 | 
			
		||||
        super(Objects.requireNonNull(message, "message cannot be null"));
 | 
			
		||||
        this.filename = null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public String getFilename()
 | 
			
		||||
    {
 | 
			
		||||
        return filename;
 | 
			
		||||
    public String getFilename() {
 | 
			
		||||
        return this.filename;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,6 +3,7 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.filesystem;
 | 
			
		||||
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
@@ -12,32 +13,31 @@ import java.io.IOException;
 | 
			
		||||
 *
 | 
			
		||||
 * This exists for use by various APIs - one should not attempt to mount it.
 | 
			
		||||
 */
 | 
			
		||||
public interface IFileSystem extends IWritableMount
 | 
			
		||||
{
 | 
			
		||||
public interface IFileSystem extends IWritableMount {
 | 
			
		||||
    /**
 | 
			
		||||
     * Combine two paths together, reducing them into a normalised form.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path  The main path.
 | 
			
		||||
     * @param path The main path.
 | 
			
		||||
     * @param child The path to append.
 | 
			
		||||
     * @return The combined, normalised path.
 | 
			
		||||
     */
 | 
			
		||||
    String combine( String path, String child );
 | 
			
		||||
    String combine(String path, String child);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Copy files from one location to another.
 | 
			
		||||
     *
 | 
			
		||||
     * @param from The location to copy from.
 | 
			
		||||
     * @param to   The location to copy to. This should not exist.
 | 
			
		||||
     * @param to The location to copy to. This should not exist.
 | 
			
		||||
     * @throws IOException If the copy failed.
 | 
			
		||||
     */
 | 
			
		||||
    void copy( String from, String to ) throws IOException;
 | 
			
		||||
    void copy(String from, String to) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Move files from one location to another.
 | 
			
		||||
     *
 | 
			
		||||
     * @param from The location to move from.
 | 
			
		||||
     * @param to   The location to move to. This should not exist.
 | 
			
		||||
     * @param to The location to move to. This should not exist.
 | 
			
		||||
     * @throws IOException If the move failed.
 | 
			
		||||
     */
 | 
			
		||||
    void move( String from, String to ) throws IOException;
 | 
			
		||||
    void move(String from, String to) throws IOException;
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,97 +3,52 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.filesystem;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
import java.io.InputStream;
 | 
			
		||||
import java.nio.channels.Channels;
 | 
			
		||||
import java.nio.channels.ReadableByteChannel;
 | 
			
		||||
import java.nio.file.attribute.BasicFileAttributes;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Represents a read only part of a virtual filesystem that can be mounted onto a computer using
 | 
			
		||||
 * {@link IComputerAccess#mount(String, IMount)}.
 | 
			
		||||
 * Represents a read only part of a virtual filesystem that can be mounted onto a computer using {@link IComputerAccess#mount(String, IMount)}.
 | 
			
		||||
 *
 | 
			
		||||
 * Ready made implementations of this interface can be created using
 | 
			
		||||
 * {@link ComputerCraftAPI#createSaveDirMount(World, String, long)} or
 | 
			
		||||
 * {@link ComputerCraftAPI#createResourceMount(Class, String, String)}, or you're free to implement it yourselves!
 | 
			
		||||
 * Ready made implementations of this interface can be created using {@link ComputerCraftAPI#createSaveDirMount(World, String, long)} or {@link
 | 
			
		||||
 * ComputerCraftAPI#createResourceMount(String, String)}, or you're free to implement it yourselves!
 | 
			
		||||
 *
 | 
			
		||||
 * @see ComputerCraftAPI#createSaveDirMount(World, String, long)
 | 
			
		||||
 * @see ComputerCraftAPI#createResourceMount(Class, String, String)
 | 
			
		||||
 * @see ComputerCraftAPI#createResourceMount(String, String)
 | 
			
		||||
 * @see IComputerAccess#mount(String, IMount)
 | 
			
		||||
 * @see IWritableMount
 | 
			
		||||
 */
 | 
			
		||||
public interface IMount
 | 
			
		||||
{
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns whether a file with a given path exists or not.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram"
 | 
			
		||||
     * @return If the file exists.
 | 
			
		||||
     * @throws IOException If an error occurs when checking the existence of the file.
 | 
			
		||||
     */
 | 
			
		||||
    boolean exists( @Nonnull String path ) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns whether a file with a given path is a directory or not.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprograms".
 | 
			
		||||
     * @return If the file exists and is a directory
 | 
			
		||||
     * @throws IOException If an error occurs when checking whether the file is a directory.
 | 
			
		||||
     */
 | 
			
		||||
    boolean isDirectory( @Nonnull String path ) throws IOException;
 | 
			
		||||
 | 
			
		||||
public interface IMount {
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the file names of all the files in a directory.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path     A file path in normalised format, relative to the mount location. ie: "programs/myprograms".
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprograms".
 | 
			
		||||
     * @param contents A list of strings. Add all the file names to this list.
 | 
			
		||||
     * @throws IOException If the file was not a directory, or could not be listed.
 | 
			
		||||
     */
 | 
			
		||||
    void list( @Nonnull String path, @Nonnull List<String> contents ) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the size of a file with a given path, in bytes.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
 | 
			
		||||
     * @return The size of the file, in bytes.
 | 
			
		||||
     * @throws IOException If the file does not exist, or its size could not be determined.
 | 
			
		||||
     */
 | 
			
		||||
    long getSize( @Nonnull String path ) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Opens a file with a given path, and returns an {@link InputStream} representing its contents.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
 | 
			
		||||
     * @return A stream representing the contents of the file.
 | 
			
		||||
     * @throws IOException If the file does not exist, or could not be opened.
 | 
			
		||||
     * @deprecated Use {@link #openChannelForRead(String)} instead
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    InputStream openForRead( @Nonnull String path ) throws IOException;
 | 
			
		||||
    void list(@Nonnull String path, @Nonnull List<String> contents) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Opens a file with a given path, and returns an {@link ReadableByteChannel} representing its contents.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
 | 
			
		||||
     * @return A channel representing the contents of the file. If the channel implements
 | 
			
		||||
     * {@link java.nio.channels.SeekableByteChannel}, one will be able to seek to arbitrary positions when using binary
 | 
			
		||||
     * mode.
 | 
			
		||||
     * @return A channel representing the contents of the file. If the channel implements {@link java.nio.channels.SeekableByteChannel}, one will be able to
 | 
			
		||||
     *     seek to arbitrary positions when using binary mode.
 | 
			
		||||
     * @throws IOException If the file does not exist, or could not be opened.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default ReadableByteChannel openChannelForRead( @Nonnull String path ) throws IOException
 | 
			
		||||
    {
 | 
			
		||||
        return Channels.newChannel( openForRead( path ) );
 | 
			
		||||
    }
 | 
			
		||||
    ReadableByteChannel openForRead(@Nonnull String path) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get attributes about the given file.
 | 
			
		||||
@@ -103,9 +58,37 @@ public interface IMount
 | 
			
		||||
     * @throws IOException If the file does not exist, or attributes could not be fetched.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default BasicFileAttributes getAttributes( @Nonnull String path ) throws IOException
 | 
			
		||||
    {
 | 
			
		||||
        if( !exists( path ) ) throw new FileOperationException( path, "No such file" );
 | 
			
		||||
        return new FileAttributes( isDirectory( path ), getSize( path ) );
 | 
			
		||||
    default BasicFileAttributes getAttributes(@Nonnull String path) throws IOException {
 | 
			
		||||
        if (!this.exists(path)) {
 | 
			
		||||
            throw new FileOperationException(path, "No such file");
 | 
			
		||||
        }
 | 
			
		||||
        return new FileAttributes(this.isDirectory(path), this.getSize(path));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns whether a file with a given path exists or not.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram"
 | 
			
		||||
     * @return If the file exists.
 | 
			
		||||
     * @throws IOException If an error occurs when checking the existence of the file.
 | 
			
		||||
     */
 | 
			
		||||
    boolean exists(@Nonnull String path) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns whether a file with a given path is a directory or not.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprograms".
 | 
			
		||||
     * @return If the file exists and is a directory
 | 
			
		||||
     * @throws IOException If an error occurs when checking whether the file is a directory.
 | 
			
		||||
     */
 | 
			
		||||
    boolean isDirectory(@Nonnull String path) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the size of a file with a given path, in bytes.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
 | 
			
		||||
     * @return The size of the file, in bytes.
 | 
			
		||||
     * @throws IOException If the file does not exist, or its size could not be determined.
 | 
			
		||||
     */
 | 
			
		||||
    long getSize(@Nonnull String path) throws IOException;
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,40 +3,41 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.filesystem;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
import java.io.OutputStream;
 | 
			
		||||
import java.nio.channels.Channels;
 | 
			
		||||
import java.nio.channels.WritableByteChannel;
 | 
			
		||||
import java.util.OptionalLong;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Represents a part of a virtual filesystem that can be mounted onto a computer using {@link IComputerAccess#mount(String, IMount)}
 | 
			
		||||
 * or {@link IComputerAccess#mountWritable(String, IWritableMount)}, that can also be written to.
 | 
			
		||||
 * Represents a part of a virtual filesystem that can be mounted onto a computer using {@link IComputerAccess#mount(String, IMount)} or {@link
 | 
			
		||||
 * IComputerAccess#mountWritable(String, IWritableMount)}, that can also be written to.
 | 
			
		||||
 *
 | 
			
		||||
 * Ready made implementations of this interface can be created using
 | 
			
		||||
 * {@link ComputerCraftAPI#createSaveDirMount(World, String, long)}, or you're free to implement it yourselves!
 | 
			
		||||
 * Ready made implementations of this interface can be created using {@link ComputerCraftAPI#createSaveDirMount(World, String, long)}, or you're free to
 | 
			
		||||
 * implement it yourselves!
 | 
			
		||||
 *
 | 
			
		||||
 * @see ComputerCraftAPI#createSaveDirMount(World, String, long)
 | 
			
		||||
 * @see IComputerAccess#mount(String, IMount)
 | 
			
		||||
 * @see IComputerAccess#mountWritable(String, IWritableMount)
 | 
			
		||||
 * @see IMount
 | 
			
		||||
 */
 | 
			
		||||
public interface IWritableMount extends IMount
 | 
			
		||||
{
 | 
			
		||||
public interface IWritableMount extends IMount {
 | 
			
		||||
    /**
 | 
			
		||||
     * Creates a directory at a given path inside the virtual file system.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/mynewprograms".
 | 
			
		||||
     * @throws IOException If the directory already exists or could not be created.
 | 
			
		||||
     */
 | 
			
		||||
    void makeDirectory( @Nonnull String path ) throws IOException;
 | 
			
		||||
    void makeDirectory(@Nonnull String path) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Deletes a directory at a given path inside the virtual file system.
 | 
			
		||||
@@ -44,63 +45,33 @@ public interface IWritableMount extends IMount
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myoldprograms".
 | 
			
		||||
     * @throws IOException If the file does not exist or could not be deleted.
 | 
			
		||||
     */
 | 
			
		||||
    void delete( @Nonnull String path ) throws IOException;
 | 
			
		||||
    void delete(@Nonnull String path) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Opens a file with a given path, and returns an {@link OutputStream} for writing to it.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
 | 
			
		||||
     * @return A stream for writing to
 | 
			
		||||
     * @throws IOException If the file could not be opened for writing.
 | 
			
		||||
     * @deprecated Use {@link #openChannelForWrite(String)} instead.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    OutputStream openForWrite( @Nonnull String path ) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Opens a file with a given path, and returns an {@link OutputStream} for writing to it.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
 | 
			
		||||
     * @return A stream for writing to. If the channel implements {@link java.nio.channels.SeekableByteChannel}, one
 | 
			
		||||
     * will be able to seek to arbitrary positions when using binary mode.
 | 
			
		||||
     * @return A stream for writing to. If the channel implements {@link java.nio.channels.SeekableByteChannel}, one will be able to seek to arbitrary
 | 
			
		||||
     *     positions when using binary mode.
 | 
			
		||||
     * @throws IOException If the file could not be opened for writing.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default WritableByteChannel openChannelForWrite( @Nonnull String path ) throws IOException
 | 
			
		||||
    {
 | 
			
		||||
        return Channels.newChannel( openForWrite( path ) );
 | 
			
		||||
    }
 | 
			
		||||
    WritableByteChannel openForWrite(@Nonnull String path) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Opens a file with a given path, and returns an {@link OutputStream} for appending to it.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
 | 
			
		||||
     * @return A stream for writing to.
 | 
			
		||||
     * @throws IOException If the file could not be opened for writing.
 | 
			
		||||
     * @deprecated Use {@link #openChannelForAppend(String)} instead.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    OutputStream openForAppend( @Nonnull String path ) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Opens a file with a given path, and returns an {@link OutputStream} for appending to it.
 | 
			
		||||
     *
 | 
			
		||||
     * @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
 | 
			
		||||
     * @return A stream for writing to. If the channel implements {@link java.nio.channels.SeekableByteChannel}, one
 | 
			
		||||
     * will be able to seek to arbitrary positions when using binary mode.
 | 
			
		||||
     * @return A stream for writing to. If the channel implements {@link java.nio.channels.SeekableByteChannel}, one will be able to seek to arbitrary
 | 
			
		||||
     *     positions when using binary mode.
 | 
			
		||||
     * @throws IOException If the file could not be opened for writing.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default WritableByteChannel openChannelForAppend( @Nonnull String path ) throws IOException
 | 
			
		||||
    {
 | 
			
		||||
        return Channels.newChannel( openForAppend( path ) );
 | 
			
		||||
    }
 | 
			
		||||
    WritableByteChannel openForAppend(@Nonnull String path) throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the amount of free space on the mount, in bytes. You should decrease this value as the user writes to the
 | 
			
		||||
     * mount, and write operations should fail once it reaches zero.
 | 
			
		||||
     * Get the amount of free space on the mount, in bytes. You should decrease this value as the user writes to the mount, and write operations should fail
 | 
			
		||||
     * once it reaches zero.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The amount of free space, in bytes.
 | 
			
		||||
     * @throws IOException If the remaining space could not be computed.
 | 
			
		||||
@@ -108,14 +79,12 @@ public interface IWritableMount extends IMount
 | 
			
		||||
    long getRemainingSpace() throws IOException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the capacity of this mount. This should be equal to the size of all files/directories on this mount, minus
 | 
			
		||||
     * the {@link #getRemainingSpace()}.
 | 
			
		||||
     * Get the capacity of this mount. This should be equal to the size of all files/directories on this mount, minus the {@link #getRemainingSpace()}.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The capacity of this mount, in bytes.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default OptionalLong getCapacity()
 | 
			
		||||
    {
 | 
			
		||||
    default OptionalLong getCapacity() {
 | 
			
		||||
        return OptionalLong.empty();
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
@API( owner = "ComputerCraft", provides = "ComputerCraft|API|FileSystem", apiVersion = "${version}" )
 | 
			
		||||
package dan200.computercraft.api.filesystem;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.API;
 | 
			
		||||
@@ -1,334 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Provides methods for extracting values and validating Lua arguments, such as those provided to
 | 
			
		||||
 * {@link ILuaObject#callMethod(ILuaContext, int, Object[])} or
 | 
			
		||||
 * {@link IPeripheral#callMethod(IComputerAccess, ILuaContext, int, Object[])}.
 | 
			
		||||
 *
 | 
			
		||||
 * This provides two sets of functions: the {@code get*} methods, which require an argument to be valid, and
 | 
			
		||||
 * {@code opt*}, which accept a default value and return that if the argument was not present or was {@code null}.
 | 
			
		||||
 * If the argument is of the wrong type, a suitable error message will be thrown, with a similar format to Lua's own
 | 
			
		||||
 * error messages.
 | 
			
		||||
 *
 | 
			
		||||
 * <h2>Example usage:</h2>
 | 
			
		||||
 * <pre>
 | 
			
		||||
 * {@code
 | 
			
		||||
 * int slot = getInt( args, 0 );
 | 
			
		||||
 * int amount = optInt( args, 1, 64 );
 | 
			
		||||
 * }
 | 
			
		||||
 * </pre>
 | 
			
		||||
 */
 | 
			
		||||
public final class ArgumentHelper
 | 
			
		||||
{
 | 
			
		||||
    private ArgumentHelper()
 | 
			
		||||
    {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a string representation of the given value's type.
 | 
			
		||||
     *
 | 
			
		||||
     * @param value The value whose type we are trying to compute.
 | 
			
		||||
     * @return A string representation of the given value's type, in a similar format to that provided by Lua's
 | 
			
		||||
     * {@code type} function.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static String getType( @Nullable Object value )
 | 
			
		||||
    {
 | 
			
		||||
        if( value == null ) return "nil";
 | 
			
		||||
        if( value instanceof String ) return "string";
 | 
			
		||||
        if( value instanceof Boolean ) return "boolean";
 | 
			
		||||
        if( value instanceof Number ) return "number";
 | 
			
		||||
        if( value instanceof Map ) return "table";
 | 
			
		||||
        return "userdata";
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Construct a "bad argument" exception, from an expected type and the actual value provided.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index    The argument number, starting from 0.
 | 
			
		||||
     * @param expected The expected type for this argument.
 | 
			
		||||
     * @param actual   The actual value provided for this argument.
 | 
			
		||||
     * @return The constructed exception, which should be thrown immediately.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static LuaException badArgumentOf( int index, @Nonnull String expected, @Nullable Object actual )
 | 
			
		||||
    {
 | 
			
		||||
        return badArgument( index, expected, getType( actual ) );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Construct a "bad argument" exception, from an expected and actual type.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index    The argument number, starting from 0.
 | 
			
		||||
     * @param expected The expected type for this argument.
 | 
			
		||||
     * @param actual   The provided type for this argument.
 | 
			
		||||
     * @return The constructed exception, which should be thrown immediately.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static LuaException badArgument( int index, @Nonnull String expected, @Nonnull String actual )
 | 
			
		||||
    {
 | 
			
		||||
        return new LuaException( "bad argument #" + (index + 1) + " (" + expected + " expected, got " + actual + ")" );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a double.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     * @see #getFiniteDouble(Object[], int) if you require this to be finite (i.e. not infinite or NaN).
 | 
			
		||||
     */
 | 
			
		||||
    public static double getDouble( @Nonnull Object[] args, int index ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        if( index >= args.length ) throw badArgument( index, "number", "nil" );
 | 
			
		||||
        Object value = args[index];
 | 
			
		||||
        if( !(value instanceof Number) ) throw badArgumentOf( index, "number", value );
 | 
			
		||||
        return ((Number) value).doubleValue();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as an integer.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not an integer.
 | 
			
		||||
     */
 | 
			
		||||
    public static int getInt( @Nonnull Object[] args, int index ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        return (int) getLong( args, index );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a long.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a long.
 | 
			
		||||
     */
 | 
			
		||||
    public static long getLong( @Nonnull Object[] args, int index ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        if( index >= args.length ) throw badArgument( index, "number", "nil" );
 | 
			
		||||
        Object value = args[index];
 | 
			
		||||
        if( !(value instanceof Number) ) throw badArgumentOf( index, "number", value );
 | 
			
		||||
        return checkFinite( index, (Number) value ).longValue();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a finite number (not infinite or NaN).
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not finite.
 | 
			
		||||
     */
 | 
			
		||||
    public static double getFiniteDouble( @Nonnull Object[] args, int index ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        return checkFinite( index, getDouble( args, index ) );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a boolean.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a boolean.
 | 
			
		||||
     */
 | 
			
		||||
    public static boolean getBoolean( @Nonnull Object[] args, int index ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        if( index >= args.length ) throw badArgument( index, "boolean", "nil" );
 | 
			
		||||
        Object value = args[index];
 | 
			
		||||
        if( !(value instanceof Boolean) ) throw badArgumentOf( index, "boolean", value );
 | 
			
		||||
        return (Boolean) value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a string.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a string.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static String getString( @Nonnull Object[] args, int index ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        if( index >= args.length ) throw badArgument( index, "string", "nil" );
 | 
			
		||||
        Object value = args[index];
 | 
			
		||||
        if( !(value instanceof String) ) throw badArgumentOf( index, "string", value );
 | 
			
		||||
        return (String) value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a table.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a table.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static Map<?, ?> getTable( @Nonnull Object[] args, int index ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        if( index >= args.length ) throw badArgument( index, "table", "nil" );
 | 
			
		||||
        Object value = args[index];
 | 
			
		||||
        if( !(value instanceof Map) ) throw badArgumentOf( index, "table", value );
 | 
			
		||||
        return (Map<?, ?>) value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a double.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @param def   The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     */
 | 
			
		||||
    public static double optDouble( @Nonnull Object[] args, int index, double def ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        Object value = index < args.length ? args[index] : null;
 | 
			
		||||
        if( value == null ) return def;
 | 
			
		||||
        if( !(value instanceof Number) ) throw badArgumentOf( index, "number", value );
 | 
			
		||||
        return ((Number) value).doubleValue();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as an int.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @param def   The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     */
 | 
			
		||||
    public static int optInt( @Nonnull Object[] args, int index, int def ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        return (int) optLong( args, index, def );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a long.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @param def   The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     */
 | 
			
		||||
    public static long optLong( @Nonnull Object[] args, int index, long def ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        Object value = index < args.length ? args[index] : null;
 | 
			
		||||
        if( value == null ) return def;
 | 
			
		||||
        if( !(value instanceof Number) ) throw badArgumentOf( index, "number", value );
 | 
			
		||||
        return checkFinite( index, (Number) value ).longValue();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a finite number (not infinite or NaN).
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @param def   The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not finite.
 | 
			
		||||
     */
 | 
			
		||||
    public static double optFiniteDouble( @Nonnull Object[] args, int index, double def ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        return checkFinite( index, optDouble( args, index, def ) );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a boolean.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @param def   The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a boolean.
 | 
			
		||||
     */
 | 
			
		||||
    public static boolean optBoolean( @Nonnull Object[] args, int index, boolean def ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        Object value = index < args.length ? args[index] : null;
 | 
			
		||||
        if( value == null ) return def;
 | 
			
		||||
        if( !(value instanceof Boolean) ) throw badArgumentOf( index, "boolean", value );
 | 
			
		||||
        return (Boolean) value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a string.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @param def   The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a string.
 | 
			
		||||
     */
 | 
			
		||||
    public static String optString( @Nonnull Object[] args, int index, String def ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        Object value = index < args.length ? args[index] : null;
 | 
			
		||||
        if( value == null ) return def;
 | 
			
		||||
        if( !(value instanceof String) ) throw badArgumentOf( index, "string", value );
 | 
			
		||||
        return (String) value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a table.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args  The arguments to extract from.
 | 
			
		||||
     * @param index The index into the argument array to read from.
 | 
			
		||||
     * @param def   The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a table.
 | 
			
		||||
     */
 | 
			
		||||
    public static Map<?, ?> optTable( @Nonnull Object[] args, int index, Map<Object, Object> def ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        Object value = index < args.length ? args[index] : null;
 | 
			
		||||
        if( value == null ) return def;
 | 
			
		||||
        if( !(value instanceof Map) ) throw badArgumentOf( index, "table", value );
 | 
			
		||||
        return (Map<?, ?>) value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static Number checkFinite( int index, Number value ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        checkFinite( index, value.doubleValue() );
 | 
			
		||||
        return value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static double checkFinite( int index, double value ) throws LuaException
 | 
			
		||||
    {
 | 
			
		||||
        if( !Double.isFinite( value ) ) throw badArgument( index, "number", getNumericType( value ) );
 | 
			
		||||
        return value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns a more detailed representation of this number's type. If this is finite, it will just return "number",
 | 
			
		||||
     * otherwise it returns whether it is infinite or NaN.
 | 
			
		||||
     *
 | 
			
		||||
     * @param value The value to extract the type for.
 | 
			
		||||
     * @return This value's numeric type.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static String getNumericType( double value )
 | 
			
		||||
    {
 | 
			
		||||
        if( Double.isNaN( value ) ) return "nan";
 | 
			
		||||
        if( value == Double.POSITIVE_INFINITY ) return "inf";
 | 
			
		||||
        if( value == Double.NEGATIVE_INFINITY ) return "-inf";
 | 
			
		||||
        return "number";
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										418
									
								
								src/main/java/dan200/computercraft/api/lua/IArguments.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										418
									
								
								src/main/java/dan200/computercraft/api/lua/IArguments.java
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,418 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import static dan200.computercraft.api.lua.LuaValues.checkFinite;
 | 
			
		||||
 | 
			
		||||
import java.nio.ByteBuffer;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.Optional;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The arguments passed to a function.
 | 
			
		||||
 */
 | 
			
		||||
public interface IArguments {
 | 
			
		||||
    /**
 | 
			
		||||
     * Drop a number of arguments. The returned arguments instance will access arguments at position {@code i + count}, rather than {@code i}. However,
 | 
			
		||||
     * errors will still use the given argument index.
 | 
			
		||||
     *
 | 
			
		||||
     * @param count The number of arguments to drop.
 | 
			
		||||
     * @return The new {@link IArguments} instance.
 | 
			
		||||
     */
 | 
			
		||||
    IArguments drop(int count);
 | 
			
		||||
 | 
			
		||||
    default Object[] getAll() {
 | 
			
		||||
        Object[] result = new Object[this.count()];
 | 
			
		||||
        for (int i = 0; i < result.length; i++) {
 | 
			
		||||
            result[i] = this.get(i);
 | 
			
		||||
        }
 | 
			
		||||
        return result;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the number of arguments passed to this function.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The number of passed arguments.
 | 
			
		||||
     */
 | 
			
		||||
    int count();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the argument at the specific index. The returned value must obey the following conversion rules:
 | 
			
		||||
     *
 | 
			
		||||
     * <ul>
 | 
			
		||||
     *   <li>Lua values of type "string" will be represented by a {@link String}.</li>
 | 
			
		||||
     *   <li>Lua values of type "number" will be represented by a {@link Number}.</li>
 | 
			
		||||
     *   <li>Lua values of type "boolean" will be represented by a {@link Boolean}.</li>
 | 
			
		||||
     *   <li>Lua values of type "table" will be represented by a {@link Map}.</li>
 | 
			
		||||
     *   <li>Lua values of any other type will be represented by a {@code null} value.</li>
 | 
			
		||||
     * </ul>
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value, or {@code null} if not present.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    Object get(int index);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as an integer.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not an integer.
 | 
			
		||||
     */
 | 
			
		||||
    default int getInt(int index) throws LuaException {
 | 
			
		||||
        return (int) this.getLong(index);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a long.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a long.
 | 
			
		||||
     */
 | 
			
		||||
    default long getLong(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (!(value instanceof Number)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "number", value);
 | 
			
		||||
        }
 | 
			
		||||
        return LuaValues.checkFiniteNum(index, (Number) value)
 | 
			
		||||
                        .longValue();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a finite number (not infinite or NaN).
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not finite.
 | 
			
		||||
     */
 | 
			
		||||
    default double getFiniteDouble(int index) throws LuaException {
 | 
			
		||||
        return checkFinite(index, this.getDouble(index));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a double.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     * @see #getFiniteDouble(int) if you require this to be finite (i.e. not infinite or NaN).
 | 
			
		||||
     */
 | 
			
		||||
    default double getDouble(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (!(value instanceof Number)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "number", value);
 | 
			
		||||
        }
 | 
			
		||||
        return ((Number) value).doubleValue();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a boolean.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a boolean.
 | 
			
		||||
     */
 | 
			
		||||
    default boolean getBoolean(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (!(value instanceof Boolean)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "boolean", value);
 | 
			
		||||
        }
 | 
			
		||||
        return (Boolean) value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a string argument as a byte array.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value. This is a <em>read only</em> buffer.
 | 
			
		||||
     * @throws LuaException If the value is not a string.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default ByteBuffer getBytes(int index) throws LuaException {
 | 
			
		||||
        return LuaValues.encode(this.getString(index));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a string.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a string.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default String getString(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (!(value instanceof String)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "string", value);
 | 
			
		||||
        }
 | 
			
		||||
        return (String) value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a string argument as an enum value.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @param klass The type of enum to parse.
 | 
			
		||||
     * @param <T> The type of enum to parse.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a string or not a valid option for this enum.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default <T extends Enum<T>> T getEnum(int index, Class<T> klass) throws LuaException {
 | 
			
		||||
        return LuaValues.checkEnum(index, klass, this.getString(index));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a table.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a table.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default Map<?, ?> getTable(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (!(value instanceof Map)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "table", value);
 | 
			
		||||
        }
 | 
			
		||||
        return (Map<?, ?>) value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a string argument as a byte array.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value, or {@link Optional#empty()} if not present. This is a <em>read only</em> buffer.
 | 
			
		||||
     * @throws LuaException If the value is not a string.
 | 
			
		||||
     */
 | 
			
		||||
    default Optional<ByteBuffer> optBytes(int index) throws LuaException {
 | 
			
		||||
        return this.optString(index).map(LuaValues::encode);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a string.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value, or {@link Optional#empty()} if not present.
 | 
			
		||||
     * @throws LuaException If the value is not a string.
 | 
			
		||||
     */
 | 
			
		||||
    default Optional<String> optString(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (value == null) {
 | 
			
		||||
            return Optional.empty();
 | 
			
		||||
        }
 | 
			
		||||
        if (!(value instanceof String)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "string", value);
 | 
			
		||||
        }
 | 
			
		||||
        return Optional.of((String) value);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a string argument as an enum value.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @param klass The type of enum to parse.
 | 
			
		||||
     * @param <T> The type of enum to parse.
 | 
			
		||||
     * @return The argument's value.
 | 
			
		||||
     * @throws LuaException If the value is not a string or not a valid option for this enum.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default <T extends Enum<T>> Optional<T> optEnum(int index, Class<T> klass) throws LuaException {
 | 
			
		||||
        Optional<String> str = this.optString(index);
 | 
			
		||||
        return str.isPresent() ? Optional.of(LuaValues.checkEnum(index, klass, str.get())) : Optional.empty();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a double.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @param def The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     */
 | 
			
		||||
    default double optDouble(int index, double def) throws LuaException {
 | 
			
		||||
        return this.optDouble(index).orElse(def);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a double.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value, or {@link Optional#empty()} if not present.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default Optional<Double> optDouble(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (value == null) {
 | 
			
		||||
            return Optional.empty();
 | 
			
		||||
        }
 | 
			
		||||
        if (!(value instanceof Number)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "number", value);
 | 
			
		||||
        }
 | 
			
		||||
        return Optional.of(((Number) value).doubleValue());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as an int.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @param def The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     */
 | 
			
		||||
    default int optInt(int index, int def) throws LuaException {
 | 
			
		||||
        return this.optInt(index).orElse(def);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as an int.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value, or {@link Optional#empty()} if not present.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default Optional<Integer> optInt(int index) throws LuaException {
 | 
			
		||||
        return this.optLong(index).map(Long::intValue);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a long.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value, or {@link Optional#empty()} if not present.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     */
 | 
			
		||||
    default Optional<Long> optLong(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (value == null) {
 | 
			
		||||
            return Optional.empty();
 | 
			
		||||
        }
 | 
			
		||||
        if (!(value instanceof Number)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "number", value);
 | 
			
		||||
        }
 | 
			
		||||
        return Optional.of(LuaValues.checkFiniteNum(index, (Number) value)
 | 
			
		||||
                                    .longValue());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a long.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @param def The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a number.
 | 
			
		||||
     */
 | 
			
		||||
    default long optLong(int index, long def) throws LuaException {
 | 
			
		||||
        return this.optLong(index).orElse(def);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a finite number (not infinite or NaN).
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @param def The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not finite.
 | 
			
		||||
     */
 | 
			
		||||
    default double optFiniteDouble(int index, double def) throws LuaException {
 | 
			
		||||
        return this.optFiniteDouble(index).orElse(def);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a finite number (not infinite or NaN).
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value, or {@link Optional#empty()} if not present.
 | 
			
		||||
     * @throws LuaException If the value is not finite.
 | 
			
		||||
     */
 | 
			
		||||
    default Optional<Double> optFiniteDouble(int index) throws LuaException {
 | 
			
		||||
        Optional<Double> value = this.optDouble(index);
 | 
			
		||||
        if (value.isPresent()) {
 | 
			
		||||
            LuaValues.checkFiniteNum(index, value.get());
 | 
			
		||||
        }
 | 
			
		||||
        return value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a boolean.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @param def The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a boolean.
 | 
			
		||||
     */
 | 
			
		||||
    default boolean optBoolean(int index, boolean def) throws LuaException {
 | 
			
		||||
        return this.optBoolean(index).orElse(def);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a boolean.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value, or {@link Optional#empty()} if not present.
 | 
			
		||||
     * @throws LuaException If the value is not a boolean.
 | 
			
		||||
     */
 | 
			
		||||
    default Optional<Boolean> optBoolean(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (value == null) {
 | 
			
		||||
            return Optional.empty();
 | 
			
		||||
        }
 | 
			
		||||
        if (!(value instanceof Boolean)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "boolean", value);
 | 
			
		||||
        }
 | 
			
		||||
        return Optional.of((Boolean) value);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a string.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @param def The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a string.
 | 
			
		||||
     */
 | 
			
		||||
    default String optString(int index, String def) throws LuaException {
 | 
			
		||||
        return this.optString(index).orElse(def);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a table.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @param def The default value, if this argument is not given.
 | 
			
		||||
     * @return The argument's value, or {@code def} if none was provided.
 | 
			
		||||
     * @throws LuaException If the value is not a table.
 | 
			
		||||
     */
 | 
			
		||||
    default Map<?, ?> optTable(int index, Map<Object, Object> def) throws LuaException {
 | 
			
		||||
        return this.optTable(index).orElse(def);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an argument as a table.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number.
 | 
			
		||||
     * @return The argument's value, or {@link Optional#empty()} if not present.
 | 
			
		||||
     * @throws LuaException If the value is not a table.
 | 
			
		||||
     */
 | 
			
		||||
    default Optional<Map<?, ?>> optTable(int index) throws LuaException {
 | 
			
		||||
        Object value = this.get(index);
 | 
			
		||||
        if (value == null) {
 | 
			
		||||
            return Optional.empty();
 | 
			
		||||
        }
 | 
			
		||||
        if (!(value instanceof Map)) {
 | 
			
		||||
            throw LuaValues.badArgumentOf(index, "map", value);
 | 
			
		||||
        }
 | 
			
		||||
        return Optional.of((Map<?, ?>) value);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -3,19 +3,18 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.filesystem.IFileSystem;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An interface passed to {@link ILuaAPIFactory} in order to provide additional information
 | 
			
		||||
 * about a computer.
 | 
			
		||||
 * An interface passed to {@link ILuaAPIFactory} in order to provide additional information about a computer.
 | 
			
		||||
 */
 | 
			
		||||
public interface IComputerSystem extends IComputerAccess
 | 
			
		||||
{
 | 
			
		||||
public interface IComputerSystem extends IComputerAccess {
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the file system for this computer.
 | 
			
		||||
     *
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,40 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IDynamicPeripheral;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An interface for representing custom objects returned by peripherals or other Lua objects.
 | 
			
		||||
 *
 | 
			
		||||
 * Generally, one does not need to implement this type - it is sufficient to return an object with some methods annotated with {@link LuaFunction}. {@link
 | 
			
		||||
 * IDynamicLuaObject} is useful when you wish your available methods to change at runtime.
 | 
			
		||||
 */
 | 
			
		||||
public interface IDynamicLuaObject {
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the names of the methods that this object implements. This should not change over the course of the object's lifetime.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The method names this object provides.
 | 
			
		||||
     * @see IDynamicPeripheral#getMethodNames()
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    String[] getMethodNames();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Called when a user calls one of the methods that this object implements.
 | 
			
		||||
     *
 | 
			
		||||
     * @param context The context of the currently running lua thread. This can be used to wait for events or otherwise yield.
 | 
			
		||||
     * @param method An integer identifying which method index from {@link #getMethodNames()} the computer wishes to call.
 | 
			
		||||
     * @param arguments The arguments for this method.
 | 
			
		||||
     * @return The result of this function. Either an immediate value ({@link MethodResult#of(Object...)} or an instruction to yield.
 | 
			
		||||
     * @throws LuaException If the function threw an exception.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    MethodResult callMethod(@Nonnull ILuaContext context, int method, @Nonnull IArguments arguments) throws LuaException;
 | 
			
		||||
}
 | 
			
		||||
@@ -3,21 +3,22 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Represents a {@link ILuaObject} which is stored as a global variable on computer startup.
 | 
			
		||||
 * Represents a Lua object which is stored as a global variable on computer startup. This must either provide {@link LuaFunction} annotated functions or
 | 
			
		||||
 * implement {@link IDynamicLuaObject}.
 | 
			
		||||
 *
 | 
			
		||||
 * Before implementing this interface, consider alternative methods of providing methods. It is generally preferred
 | 
			
		||||
 * to use peripherals to provide functionality to users.
 | 
			
		||||
 * Before implementing this interface, consider alternative methods of providing methods. It is generally preferred to use peripherals to provide
 | 
			
		||||
 * functionality to users.
 | 
			
		||||
 *
 | 
			
		||||
 * @see ILuaAPIFactory
 | 
			
		||||
 * @see ComputerCraftAPI#registerAPIFactory(ILuaAPIFactory)
 | 
			
		||||
 */
 | 
			
		||||
public interface ILuaAPI extends ILuaObject
 | 
			
		||||
{
 | 
			
		||||
public interface ILuaAPI {
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the globals this API will be assigned to. This will override any other global, so you should
 | 
			
		||||
     *
 | 
			
		||||
@@ -30,15 +31,13 @@ public interface ILuaAPI extends ILuaObject
 | 
			
		||||
     *
 | 
			
		||||
     * One should only interact with the file system.
 | 
			
		||||
     */
 | 
			
		||||
    default void startup()
 | 
			
		||||
    {
 | 
			
		||||
    default void startup() {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Called every time the computer is ticked. This can be used to process various.
 | 
			
		||||
     */
 | 
			
		||||
    default void update()
 | 
			
		||||
    {
 | 
			
		||||
    default void update() {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -46,7 +45,6 @@ public interface ILuaAPI extends ILuaObject
 | 
			
		||||
     *
 | 
			
		||||
     * This should reset the state of the object, disposing any remaining file handles, or other resources.
 | 
			
		||||
     */
 | 
			
		||||
    default void shutdown()
 | 
			
		||||
    {
 | 
			
		||||
    default void shutdown() {
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,13 +3,14 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Construct an {@link ILuaAPI} for a specific computer.
 | 
			
		||||
 *
 | 
			
		||||
@@ -17,8 +18,7 @@ import javax.annotation.Nullable;
 | 
			
		||||
 * @see ComputerCraftAPI#registerAPIFactory(ILuaAPIFactory)
 | 
			
		||||
 */
 | 
			
		||||
@FunctionalInterface
 | 
			
		||||
public interface ILuaAPIFactory
 | 
			
		||||
{
 | 
			
		||||
public interface ILuaAPIFactory {
 | 
			
		||||
    /**
 | 
			
		||||
     * Create a new API instance for a given computer.
 | 
			
		||||
     *
 | 
			
		||||
@@ -26,5 +26,5 @@ public interface ILuaAPIFactory
 | 
			
		||||
     * @return The created API, or {@code null} if one should not be injected.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    ILuaAPI create( @Nonnull IComputerSystem computer );
 | 
			
		||||
    ILuaAPI create(@Nonnull IComputerSystem computer);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										26
									
								
								src/main/java/dan200/computercraft/api/lua/ILuaCallback.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								src/main/java/dan200/computercraft/api/lua/ILuaCallback.java
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,26 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A continuation which is called when this coroutine is resumed.
 | 
			
		||||
 *
 | 
			
		||||
 * @see MethodResult#yield(Object[], ILuaCallback)
 | 
			
		||||
 */
 | 
			
		||||
public interface ILuaCallback {
 | 
			
		||||
    /**
 | 
			
		||||
     * Resume this coroutine.
 | 
			
		||||
     *
 | 
			
		||||
     * @param args The result of resuming this coroutine. These will have the same form as described in {@link LuaFunction}.
 | 
			
		||||
     * @return The result of this continuation. Either the result to return to the callee, or another yield.
 | 
			
		||||
     * @throws LuaException On an error.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    MethodResult resume(Object[] args) throws LuaException;
 | 
			
		||||
}
 | 
			
		||||
@@ -3,102 +3,27 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An interface passed to peripherals and {@link ILuaObject}s by computers or turtles, providing methods
 | 
			
		||||
 * that allow the peripheral call to wait for events before returning, just like in lua. This is very useful if you need
 | 
			
		||||
 * to signal work to be performed on the main thread, and don't want to return until the work has been completed.
 | 
			
		||||
 * An interface passed to peripherals and {@link IDynamicLuaObject}s by computers or turtles, providing methods that allow the peripheral call to interface
 | 
			
		||||
 * with the computer.
 | 
			
		||||
 */
 | 
			
		||||
public interface ILuaContext
 | 
			
		||||
{
 | 
			
		||||
public interface ILuaContext {
 | 
			
		||||
    /**
 | 
			
		||||
     * Wait for an event to occur on the computer, suspending the thread until it arises. This method is exactly
 | 
			
		||||
     * equivalent to {@code os.pullEvent()} in lua.
 | 
			
		||||
     * Queue a task to be executed on the main server thread at the beginning of next tick, but do not wait for it to complete. This should be used when you
 | 
			
		||||
     * need to interact with the world in a thread-safe manner but do not care about the result or you wish to run asynchronously.
 | 
			
		||||
     *
 | 
			
		||||
     * @param filter A specific event to wait for, or null to wait for any event.
 | 
			
		||||
     * @return An object array containing the name of the event that occurred, and any event parameters.
 | 
			
		||||
     * @throws LuaException         If the user presses CTRL+T to terminate the current program while pullEvent() is
 | 
			
		||||
     *                              waiting for an event, a "Terminated" exception will be thrown here.
 | 
			
		||||
     *
 | 
			
		||||
     *                              Do not attempt to catch this exception. You should use {@link #pullEventRaw(String)}
 | 
			
		||||
     *                              should you wish to disable termination.
 | 
			
		||||
     * @throws InterruptedException If the user shuts down or reboots the computer while pullEvent() is waiting for an
 | 
			
		||||
     *                              event, InterruptedException will be thrown. This exception must not be caught or
 | 
			
		||||
     *                              intercepted, or the computer will leak memory and end up in a broken state.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default Object[] pullEvent( @Nullable String filter ) throws LuaException, InterruptedException
 | 
			
		||||
    {
 | 
			
		||||
        Object[] results = pullEventRaw( filter );
 | 
			
		||||
        if( results.length >= 1 && results[0].equals( "terminate" ) ) throw new LuaException( "Terminated", 0 );
 | 
			
		||||
        return results;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * The same as {@link #pullEvent(String)}, except "terminated" events are ignored. Only use this if you want to
 | 
			
		||||
     * prevent program termination, which is not recommended. This method is exactly equivalent to
 | 
			
		||||
     * {@code os.pullEventRaw()} in lua.
 | 
			
		||||
     *
 | 
			
		||||
     * @param filter A specific event to wait for, or null to wait for any event.
 | 
			
		||||
     * @return An object array containing the name of the event that occurred, and any event parameters.
 | 
			
		||||
     * @throws InterruptedException If the user shuts down or reboots the computer while pullEventRaw() is waiting for
 | 
			
		||||
     *                              an event, InterruptedException will be thrown. This exception must not be caught or
 | 
			
		||||
     *                              intercepted, or the computer will leak memory and end up in a broken state.
 | 
			
		||||
     * @see #pullEvent(String)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default Object[] pullEventRaw( @Nullable String filter ) throws InterruptedException
 | 
			
		||||
    {
 | 
			
		||||
        return yield( new Object[] { filter } );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Yield the current coroutine with some arguments until it is resumed. This method is exactly equivalent to
 | 
			
		||||
     * {@code coroutine.yield()} in lua. Use {@code pullEvent()} if you wish to wait for events.
 | 
			
		||||
     *
 | 
			
		||||
     * @param arguments An object array containing the arguments to pass to coroutine.yield()
 | 
			
		||||
     * @return An object array containing the return values from coroutine.yield()
 | 
			
		||||
     * @throws InterruptedException If the user shuts down or reboots the computer the coroutine is suspended,
 | 
			
		||||
     *                              InterruptedException will be thrown. This exception must not be caught or
 | 
			
		||||
     *                              intercepted, or the computer will leak memory and end up in a broken state.
 | 
			
		||||
     * @see #pullEvent(String)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    Object[] yield( @Nullable Object[] arguments ) throws InterruptedException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Queue a task to be executed on the main server thread at the beginning of next tick, waiting for it to complete.
 | 
			
		||||
     * This should be used when you need to interact with the world in a thread-safe manner.
 | 
			
		||||
     *
 | 
			
		||||
     * Note that the return values of your task are handled as events, meaning more complex objects such as maps or
 | 
			
		||||
     * {@link ILuaObject} will not preserve their identities.
 | 
			
		||||
     *
 | 
			
		||||
     * @param task The task to execute on the main thread.
 | 
			
		||||
     * @return The objects returned by {@code task}.
 | 
			
		||||
     * @throws LuaException         If the task could not be queued, or if the task threw an exception.
 | 
			
		||||
     * @throws InterruptedException If the user shuts down or reboots the computer the coroutine is suspended,
 | 
			
		||||
     *                              InterruptedException will be thrown. This exception must not be caught or
 | 
			
		||||
     *                              intercepted, or the computer will leak memory and end up in a broken state.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    Object[] executeMainThreadTask( @Nonnull ILuaTask task ) throws LuaException, InterruptedException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Queue a task to be executed on the main server thread at the beginning of next tick, but do not wait for it to
 | 
			
		||||
     * complete. This should be used when you need to interact with the world in a thread-safe manner but do not care
 | 
			
		||||
     * about the result or you wish to run asynchronously.
 | 
			
		||||
     *
 | 
			
		||||
     * When the task has finished, it will enqueue a {@code task_completed} event, which takes the task id, a success
 | 
			
		||||
     * value and the return values, or an error message if it failed. If you need to wait on this event, it may be
 | 
			
		||||
     * better to use {@link #executeMainThreadTask(ILuaTask)}.
 | 
			
		||||
     * When the task has finished, it will enqueue a {@code task_completed} event, which takes the task id, a success value and the return values, or an
 | 
			
		||||
     * error message if it failed.
 | 
			
		||||
     *
 | 
			
		||||
     * @param task The task to execute on the main thread.
 | 
			
		||||
     * @return The "id" of the task. This will be the first argument to the {@code task_completed} event.
 | 
			
		||||
     * @throws LuaException If the task could not be queued.
 | 
			
		||||
     * @see LuaFunction#mainThread() To run functions on the main thread and return their results synchronously.
 | 
			
		||||
     */
 | 
			
		||||
    long issueMainThreadTask( @Nonnull ILuaTask task ) throws LuaException;
 | 
			
		||||
    long issueMainThreadTask(@Nonnull ILuaTask task) throws LuaException;
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										29
									
								
								src/main/java/dan200/computercraft/api/lua/ILuaFunction.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								src/main/java/dan200/computercraft/api/lua/ILuaFunction.java
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,29 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A function, which can be called from Lua. If you need to return a table of functions, it is recommended to use an object with {@link LuaFunction}
 | 
			
		||||
 * methods, or implement {@link IDynamicLuaObject}.
 | 
			
		||||
 *
 | 
			
		||||
 * @see MethodResult#of(Object)
 | 
			
		||||
 */
 | 
			
		||||
@FunctionalInterface
 | 
			
		||||
public interface ILuaFunction {
 | 
			
		||||
    /**
 | 
			
		||||
     * Call this function with a series of arguments. Note, this will <em>always</em> be called on the computer thread, and so its implementation must be
 | 
			
		||||
     * thread-safe.
 | 
			
		||||
     *
 | 
			
		||||
     * @param arguments The arguments for this function
 | 
			
		||||
     * @return The result of calling this function.
 | 
			
		||||
     * @throws LuaException Upon Lua errors.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    MethodResult call(@Nonnull IArguments arguments) throws LuaException;
 | 
			
		||||
}
 | 
			
		||||
@@ -1,55 +1,18 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2019. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An interface for representing custom objects returned by {@link IPeripheral#callMethod(IComputerAccess, ILuaContext, int, Object[])}
 | 
			
		||||
 * calls.
 | 
			
		||||
 *
 | 
			
		||||
 * Return objects implementing this interface to expose objects with methods to lua.
 | 
			
		||||
 */
 | 
			
		||||
public interface ILuaObject
 | 
			
		||||
{
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the names of the methods that this object implements. This works the same as {@link IPeripheral#getMethodNames()}.
 | 
			
		||||
     * See that method for detailed documentation.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The method names this object provides.
 | 
			
		||||
     * @see IPeripheral#getMethodNames()
 | 
			
		||||
     */
 | 
			
		||||
public interface ILuaObject {
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    String[] getMethodNames();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Called when a user calls one of the methods that this object implements. This works the same as
 | 
			
		||||
     * {@link IPeripheral#callMethod(IComputerAccess, ILuaContext, int, Object[])}}. See that method for detailed
 | 
			
		||||
     * documentation.
 | 
			
		||||
     *
 | 
			
		||||
     * @param context   The context of the currently running lua thread. This can be used to wait for events
 | 
			
		||||
     *                  or otherwise yield.
 | 
			
		||||
     * @param method    An integer identifying which of the methods from getMethodNames() the computercraft
 | 
			
		||||
     *                  wishes to call. The integer indicates the index into the getMethodNames() table
 | 
			
		||||
     *                  that corresponds to the string passed into peripheral.call()
 | 
			
		||||
     * @param arguments The arguments for this method. See {@link IPeripheral#callMethod(IComputerAccess, ILuaContext, int, Object[])}
 | 
			
		||||
     *                  the possible values and conversion rules.
 | 
			
		||||
     * @return An array of objects, representing the values you wish to return to the Lua program.
 | 
			
		||||
     * See {@link IPeripheral#callMethod(IComputerAccess, ILuaContext, int, Object[])} for the valid values and
 | 
			
		||||
     * conversion rules.
 | 
			
		||||
     * @throws LuaException         If the task could not be queued, or if the task threw an exception.
 | 
			
		||||
     * @throws InterruptedException If the user shuts down or reboots the computer the coroutine is suspended,
 | 
			
		||||
     *                              InterruptedException will be thrown. This exception must not be caught or
 | 
			
		||||
     *                              intercepted, or the computer will leak memory and end up in a broken state.w
 | 
			
		||||
     * @see IPeripheral#callMethod(IComputerAccess, ILuaContext, int, Object[])
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    Object[] callMethod( @Nonnull ILuaContext context, int method, @Nonnull Object[] arguments ) throws LuaException, InterruptedException;
 | 
			
		||||
    Object[] callMethod(@Nonnull ILuaContext context, int method, @Nonnull Object[] arguments) throws LuaException, InterruptedException;
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,29 +3,25 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A task which can be executed via {@link ILuaContext#executeMainThreadTask(ILuaTask)} or
 | 
			
		||||
 * {@link ILuaContext#issueMainThreadTask(ILuaTask)}. This will be run on the main thread, at the beginning of the
 | 
			
		||||
 * next tick.
 | 
			
		||||
 * A task which can be executed via {@link ILuaContext#issueMainThreadTask(ILuaTask)} This will be run on the main thread, at the beginning of the next
 | 
			
		||||
 * tick.
 | 
			
		||||
 *
 | 
			
		||||
 * @see ILuaContext#executeMainThreadTask(ILuaTask)
 | 
			
		||||
 * @see ILuaContext#issueMainThreadTask(ILuaTask)
 | 
			
		||||
 */
 | 
			
		||||
@FunctionalInterface
 | 
			
		||||
public interface ILuaTask
 | 
			
		||||
{
 | 
			
		||||
public interface ILuaTask {
 | 
			
		||||
    /**
 | 
			
		||||
     * Execute this task.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The arguments to add to the {@code task_completed} event. These will be returned by
 | 
			
		||||
     * {@link ILuaContext#executeMainThreadTask(ILuaTask)}.
 | 
			
		||||
     * @throws LuaException If you throw any exception from this function, a lua error will be raised with the
 | 
			
		||||
     *                      same message as your exception. Use this to throw appropriate errors if the wrong
 | 
			
		||||
     *                      arguments are supplied to your method.
 | 
			
		||||
     * @return The arguments to add to the {@code task_completed} event.
 | 
			
		||||
     * @throws LuaException If you throw any exception from this function, a lua error will be raised with the same message as your exception. Use this
 | 
			
		||||
     *     to throw appropriate errors if the wrong arguments are supplied to your method.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    Object[] execute() throws LuaException;
 | 
			
		||||
 
 | 
			
		||||
@@ -3,6 +3,7 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
@@ -10,35 +11,38 @@ import javax.annotation.Nullable;
 | 
			
		||||
/**
 | 
			
		||||
 * An exception representing an error in Lua, like that raised by the {@code error()} function.
 | 
			
		||||
 */
 | 
			
		||||
public class LuaException extends Exception
 | 
			
		||||
{
 | 
			
		||||
public class LuaException extends Exception {
 | 
			
		||||
    private static final long serialVersionUID = -6136063076818512651L;
 | 
			
		||||
    private final boolean hasLevel;
 | 
			
		||||
    private final int level;
 | 
			
		||||
 | 
			
		||||
    public LuaException()
 | 
			
		||||
    {
 | 
			
		||||
        this( "error", 1 );
 | 
			
		||||
    public LuaException(@Nullable String message) {
 | 
			
		||||
        super(message);
 | 
			
		||||
        this.hasLevel = false;
 | 
			
		||||
        this.level = 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public LuaException( @Nullable String message )
 | 
			
		||||
    {
 | 
			
		||||
        this( message, 1 );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public LuaException( @Nullable String message, int level )
 | 
			
		||||
    {
 | 
			
		||||
        super( message );
 | 
			
		||||
    public LuaException(@Nullable String message, int level) {
 | 
			
		||||
        super(message);
 | 
			
		||||
        this.hasLevel = true;
 | 
			
		||||
        this.level = level;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * The level this error is raised at. Level 1 is the function's caller, level 2 is that function's caller, and so
 | 
			
		||||
     * on.
 | 
			
		||||
     * Whether a level was explicitly specified when constructing. This is used to determine
 | 
			
		||||
     *
 | 
			
		||||
     * @return Whether this has an explicit level.
 | 
			
		||||
     */
 | 
			
		||||
    public boolean hasLevel() {
 | 
			
		||||
        return this.hasLevel;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * The level this error is raised at. Level 1 is the function's caller, level 2 is that function's caller, and so on.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The level to raise the error at.
 | 
			
		||||
     */
 | 
			
		||||
    public int getLevel()
 | 
			
		||||
    {
 | 
			
		||||
        return level;
 | 
			
		||||
    public int getLevel() {
 | 
			
		||||
        return this.level;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										61
									
								
								src/main/java/dan200/computercraft/api/lua/LuaFunction.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										61
									
								
								src/main/java/dan200/computercraft/api/lua/LuaFunction.java
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,61 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import java.lang.annotation.Documented;
 | 
			
		||||
import java.lang.annotation.ElementType;
 | 
			
		||||
import java.lang.annotation.Retention;
 | 
			
		||||
import java.lang.annotation.RetentionPolicy;
 | 
			
		||||
import java.lang.annotation.Target;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.Optional;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Used to mark a Java function which is callable from Lua.
 | 
			
		||||
 *
 | 
			
		||||
 * Methods annotated with {@link LuaFunction} must be public final instance methods. They can have any number of parameters, but they must be of the
 | 
			
		||||
 * following types:
 | 
			
		||||
 *
 | 
			
		||||
 * <ul>
 | 
			
		||||
 *   <li>{@link ILuaContext} (and {@link IComputerAccess} if on a {@link IPeripheral})</li>
 | 
			
		||||
 *   <li>{@link IArguments}: The arguments supplied to this function.</li>
 | 
			
		||||
 *   <li>
 | 
			
		||||
 *     Alternatively, one may specify the desired arguments as normal parameters and the argument parsing code will
 | 
			
		||||
 *     be generated automatically.
 | 
			
		||||
 *
 | 
			
		||||
 *     Each parameter must be one of the given types supported by {@link IArguments} (for instance, {@link int} or
 | 
			
		||||
 *     {@link Map}). Optional values are supported by accepting a parameter of type {@link Optional}.
 | 
			
		||||
 *   </li>
 | 
			
		||||
 * </ul>
 | 
			
		||||
 *
 | 
			
		||||
 * This function may return {@link MethodResult}. However, if you simply return a value (rather than having to yield),
 | 
			
		||||
 * you may return {@code void}, a single value (either an object or a primitive like {@code int}) or array of objects.
 | 
			
		||||
 * These will be treated the same as {@link MethodResult#of()}, {@link MethodResult#of(Object)} and
 | 
			
		||||
 * {@link MethodResult#of(Object...)}.
 | 
			
		||||
 */
 | 
			
		||||
@Documented
 | 
			
		||||
@Retention (RetentionPolicy.RUNTIME)
 | 
			
		||||
@Target (ElementType.METHOD)
 | 
			
		||||
public @interface LuaFunction {
 | 
			
		||||
    /**
 | 
			
		||||
     * Explicitly specify the method names of this function. If not given, it uses the name of the annotated method.
 | 
			
		||||
     *
 | 
			
		||||
     * @return This function's name(s).
 | 
			
		||||
     */
 | 
			
		||||
    String[] value() default {};
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Run this function on the main server thread. This should be specified for any method which interacts with Minecraft in a thread-unsafe manner.
 | 
			
		||||
     *
 | 
			
		||||
     * @return Whether this functi
 | 
			
		||||
     * @see ILuaContext#issueMainThreadTask(ILuaTask)
 | 
			
		||||
     */
 | 
			
		||||
    boolean mainThread() default false;
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										163
									
								
								src/main/java/dan200/computercraft/api/lua/LuaValues.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										163
									
								
								src/main/java/dan200/computercraft/api/lua/LuaValues.java
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,163 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import java.nio.ByteBuffer;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Various utility functions for operating with Lua values.
 | 
			
		||||
 *
 | 
			
		||||
 * @see IArguments
 | 
			
		||||
 */
 | 
			
		||||
public final class LuaValues {
 | 
			
		||||
    private LuaValues() {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Encode a Lua string into a read-only {@link ByteBuffer}.
 | 
			
		||||
     *
 | 
			
		||||
     * @param string The string to encode.
 | 
			
		||||
     * @return The encoded string.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static ByteBuffer encode(@Nonnull String string) {
 | 
			
		||||
        byte[] chars = new byte[string.length()];
 | 
			
		||||
        for (int i = 0; i < chars.length; i++) {
 | 
			
		||||
            char c = string.charAt(i);
 | 
			
		||||
            chars[i] = c < 256 ? (byte) c : 63;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return ByteBuffer.wrap(chars)
 | 
			
		||||
                         .asReadOnlyBuffer();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Construct a "bad argument" exception, from an expected type and the actual value provided.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number, starting from 0.
 | 
			
		||||
     * @param expected The expected type for this argument.
 | 
			
		||||
     * @param actual The actual value provided for this argument.
 | 
			
		||||
     * @return The constructed exception, which should be thrown immediately.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static LuaException badArgumentOf(int index, @Nonnull String expected, @Nullable Object actual) {
 | 
			
		||||
        return badArgument(index, expected, getType(actual));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Construct a "bad argument" exception, from an expected and actual type.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument number, starting from 0.
 | 
			
		||||
     * @param expected The expected type for this argument.
 | 
			
		||||
     * @param actual The provided type for this argument.
 | 
			
		||||
     * @return The constructed exception, which should be thrown immediately.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static LuaException badArgument(int index, @Nonnull String expected, @Nonnull String actual) {
 | 
			
		||||
        return new LuaException("bad argument #" + (index + 1) + " (" + expected + " expected, got " + actual + ")");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a string representation of the given value's type.
 | 
			
		||||
     *
 | 
			
		||||
     * @param value The value whose type we are trying to compute.
 | 
			
		||||
     * @return A string representation of the given value's type, in a similar format to that provided by Lua's {@code type} function.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static String getType(@Nullable Object value) {
 | 
			
		||||
        if (value == null) {
 | 
			
		||||
            return "nil";
 | 
			
		||||
        }
 | 
			
		||||
        if (value instanceof String) {
 | 
			
		||||
            return "string";
 | 
			
		||||
        }
 | 
			
		||||
        if (value instanceof Boolean) {
 | 
			
		||||
            return "boolean";
 | 
			
		||||
        }
 | 
			
		||||
        if (value instanceof Number) {
 | 
			
		||||
            return "number";
 | 
			
		||||
        }
 | 
			
		||||
        if (value instanceof Map) {
 | 
			
		||||
            return "table";
 | 
			
		||||
        }
 | 
			
		||||
        return "userdata";
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Ensure a numeric argument is finite (i.e. not infinite or {@link Double#NaN}.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument index to check.
 | 
			
		||||
     * @param value The value to check.
 | 
			
		||||
     * @return The input {@code value}.
 | 
			
		||||
     * @throws LuaException If this is not a finite number.
 | 
			
		||||
     */
 | 
			
		||||
    public static Number checkFiniteNum(int index, Number value) throws LuaException {
 | 
			
		||||
        checkFinite(index, value.doubleValue());
 | 
			
		||||
        return value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Ensure a numeric argument is finite (i.e. not infinite or {@link Double#NaN}.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument index to check.
 | 
			
		||||
     * @param value The value to check.
 | 
			
		||||
     * @return The input {@code value}.
 | 
			
		||||
     * @throws LuaException If this is not a finite number.
 | 
			
		||||
     */
 | 
			
		||||
    public static double checkFinite(int index, double value) throws LuaException {
 | 
			
		||||
        if (!Double.isFinite(value)) {
 | 
			
		||||
            throw badArgument(index, "number", getNumericType(value));
 | 
			
		||||
        }
 | 
			
		||||
        return value;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns a more detailed representation of this number's type. If this is finite, it will just return "number", otherwise it returns whether it is
 | 
			
		||||
     * infinite or NaN.
 | 
			
		||||
     *
 | 
			
		||||
     * @param value The value to extract the type for.
 | 
			
		||||
     * @return This value's numeric type.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static String getNumericType(double value) {
 | 
			
		||||
        if (Double.isNaN(value)) {
 | 
			
		||||
            return "nan";
 | 
			
		||||
        }
 | 
			
		||||
        if (value == Double.POSITIVE_INFINITY) {
 | 
			
		||||
            return "inf";
 | 
			
		||||
        }
 | 
			
		||||
        if (value == Double.NEGATIVE_INFINITY) {
 | 
			
		||||
            return "-inf";
 | 
			
		||||
        }
 | 
			
		||||
        return "number";
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Ensure a string is a valid enum value.
 | 
			
		||||
     *
 | 
			
		||||
     * @param index The argument index to check.
 | 
			
		||||
     * @param klass The class of the enum instance.
 | 
			
		||||
     * @param value The value to extract.
 | 
			
		||||
     * @param <T> The type of enum we are extracting.
 | 
			
		||||
     * @return The parsed enum value.
 | 
			
		||||
     * @throws LuaException If this is not a known enum value.
 | 
			
		||||
     */
 | 
			
		||||
    public static <T extends Enum<T>> T checkEnum(int index, Class<T> klass, String value) throws LuaException {
 | 
			
		||||
        for (T possibility : klass.getEnumConstants()) {
 | 
			
		||||
            if (possibility.name()
 | 
			
		||||
                           .equalsIgnoreCase(value)) {
 | 
			
		||||
                return possibility;
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        throw new LuaException("bad argument #" + (index + 1) + " (unknown option " + value + ")");
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										162
									
								
								src/main/java/dan200/computercraft/api/lua/MethodResult.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										162
									
								
								src/main/java/dan200/computercraft/api/lua/MethodResult.java
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,162 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import java.nio.ByteBuffer;
 | 
			
		||||
import java.util.Collection;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The result of invoking a Lua method.
 | 
			
		||||
 *
 | 
			
		||||
 * Method results either return a value immediately ({@link #of(Object...)} or yield control to the parent coroutine. When the current coroutine is resumed,
 | 
			
		||||
 * we invoke the provided {@link ILuaCallback#resume(Object[])} callback.
 | 
			
		||||
 */
 | 
			
		||||
public final class MethodResult {
 | 
			
		||||
    private static final MethodResult empty = new MethodResult(null, null);
 | 
			
		||||
 | 
			
		||||
    private final Object[] result;
 | 
			
		||||
    private final ILuaCallback callback;
 | 
			
		||||
    private final int adjust;
 | 
			
		||||
 | 
			
		||||
    private MethodResult(Object[] arguments, ILuaCallback callback) {
 | 
			
		||||
        this.result = arguments;
 | 
			
		||||
        this.callback = callback;
 | 
			
		||||
        this.adjust = 0;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private MethodResult(Object[] arguments, ILuaCallback callback, int adjust) {
 | 
			
		||||
        this.result = arguments;
 | 
			
		||||
        this.callback = callback;
 | 
			
		||||
        this.adjust = adjust;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Return no values immediately.
 | 
			
		||||
     *
 | 
			
		||||
     * @return A method result which returns immediately with no values.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static MethodResult of() {
 | 
			
		||||
        return empty;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Return a single value immediately.
 | 
			
		||||
     *
 | 
			
		||||
     * Integers, doubles, floats, strings, booleans, {@link Map}, {@link Collection}s, arrays and {@code null} will be converted to their corresponding Lua
 | 
			
		||||
     * type. {@code byte[]} and {@link ByteBuffer} will be treated as binary strings. {@link ILuaFunction} will be treated as a function.
 | 
			
		||||
     *
 | 
			
		||||
     * In order to provide a custom object with methods, one may return a {@link IDynamicLuaObject}, or an arbitrary class with {@link LuaFunction}
 | 
			
		||||
     * annotations. Anything else will be converted to {@code nil}.
 | 
			
		||||
     *
 | 
			
		||||
     * @param value The value to return to the calling Lua function.
 | 
			
		||||
     * @return A method result which returns immediately with the given value.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static MethodResult of(@Nullable Object value) {
 | 
			
		||||
        return new MethodResult(new Object[] {value}, null);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Return any number of values immediately.
 | 
			
		||||
     *
 | 
			
		||||
     * @param values The values to return. See {@link #of(Object)} for acceptable values.
 | 
			
		||||
     * @return A method result which returns immediately with the given values.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static MethodResult of(@Nullable Object... values) {
 | 
			
		||||
        return values == null || values.length == 0 ? empty : new MethodResult(values, null);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Wait for an event to occur on the computer, suspending the thread until it arises. This method is exactly equivalent to {@code os.pullEvent()} in
 | 
			
		||||
     * lua.
 | 
			
		||||
     *
 | 
			
		||||
     * @param filter A specific event to wait for, or null to wait for any event.
 | 
			
		||||
     * @param callback The callback to resume with the name of the event that occurred, and any event parameters.
 | 
			
		||||
     * @return The method result which represents this yield.
 | 
			
		||||
     * @see IComputerAccess#queueEvent(String, Object[])
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static MethodResult pullEvent(@Nullable String filter, @Nonnull ILuaCallback callback) {
 | 
			
		||||
        Objects.requireNonNull(callback, "callback cannot be null");
 | 
			
		||||
        return new MethodResult(new Object[] {filter}, results -> {
 | 
			
		||||
            if (results.length >= 1 && results[0].equals("terminate")) {
 | 
			
		||||
                throw new LuaException("Terminated", 0);
 | 
			
		||||
            }
 | 
			
		||||
            return callback.resume(results);
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * The same as {@link #pullEvent(String, ILuaCallback)}, except "terminated" events are ignored. Only use this if you want to prevent program
 | 
			
		||||
     * termination, which is not recommended. This method is exactly equivalent to {@code os.pullEventRaw()} in Lua.
 | 
			
		||||
     *
 | 
			
		||||
     * @param filter A specific event to wait for, or null to wait for any event.
 | 
			
		||||
     * @param callback The callback to resume with the name of the event that occurred, and any event parameters.
 | 
			
		||||
     * @return The method result which represents this yield.
 | 
			
		||||
     * @see #pullEvent(String, ILuaCallback)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static MethodResult pullEventRaw(@Nullable String filter, @Nonnull ILuaCallback callback) {
 | 
			
		||||
        Objects.requireNonNull(callback, "callback cannot be null");
 | 
			
		||||
        return new MethodResult(new Object[] {filter}, callback);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Yield the current coroutine with some arguments until it is resumed. This method is exactly equivalent to {@code coroutine.yield()} in lua. Use
 | 
			
		||||
     * {@code pullEvent()} if you wish to wait for events.
 | 
			
		||||
     *
 | 
			
		||||
     * @param arguments An object array containing the arguments to pass to coroutine.yield()
 | 
			
		||||
     * @param callback The callback to resume with an array containing the return values from coroutine.yield()
 | 
			
		||||
     * @return The method result which represents this yield.
 | 
			
		||||
     * @see #pullEvent(String, ILuaCallback)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static MethodResult yield(@Nullable Object[] arguments, @Nonnull ILuaCallback callback) {
 | 
			
		||||
        Objects.requireNonNull(callback, "callback cannot be null");
 | 
			
		||||
        return new MethodResult(arguments, callback);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public Object[] getResult() {
 | 
			
		||||
        return this.result;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public ILuaCallback getCallback() {
 | 
			
		||||
        return this.callback;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public int getErrorAdjust() {
 | 
			
		||||
        return this.adjust;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Increase the Lua error by a specific amount. One should never need to use this function - it largely exists for some CC internal code.
 | 
			
		||||
     *
 | 
			
		||||
     * @param adjust The amount to increase the level by.
 | 
			
		||||
     * @return The new {@link MethodResult} with an adjusted error. This has no effect on immediate results.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public MethodResult adjustError(int adjust) {
 | 
			
		||||
        if (adjust < 0) {
 | 
			
		||||
            throw new IllegalArgumentException("cannot adjust by a negative amount");
 | 
			
		||||
        }
 | 
			
		||||
        if (adjust == 0 || this.callback == null) {
 | 
			
		||||
            return this;
 | 
			
		||||
        }
 | 
			
		||||
        return new MethodResult(this.result, this.callback, this.adjust + adjust);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -0,0 +1,66 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import java.util.Arrays;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An implementation of {@link IArguments} which wraps an array of {@link Object}.
 | 
			
		||||
 */
 | 
			
		||||
public final class ObjectArguments implements IArguments {
 | 
			
		||||
    private static final IArguments EMPTY = new ObjectArguments();
 | 
			
		||||
    private final List<Object> args;
 | 
			
		||||
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    @SuppressWarnings ("unused")
 | 
			
		||||
    public ObjectArguments(IArguments arguments) {
 | 
			
		||||
        throw new IllegalStateException();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public ObjectArguments(Object... args) {
 | 
			
		||||
        this.args = Arrays.asList(args);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public ObjectArguments(List<Object> args) {
 | 
			
		||||
        this.args = Objects.requireNonNull(args);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public IArguments drop(int count) {
 | 
			
		||||
        if (count < 0) {
 | 
			
		||||
            throw new IllegalStateException("count cannot be negative");
 | 
			
		||||
        }
 | 
			
		||||
        if (count == 0) {
 | 
			
		||||
            return this;
 | 
			
		||||
        }
 | 
			
		||||
        if (count >= this.args.size()) {
 | 
			
		||||
            return EMPTY;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return new ObjectArguments(this.args.subList(count, this.args.size()));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public Object[] getAll() {
 | 
			
		||||
        return this.args.toArray();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public int count() {
 | 
			
		||||
        return this.args.size();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nullable
 | 
			
		||||
    @Override
 | 
			
		||||
    public Object get(int index) {
 | 
			
		||||
        return index >= this.args.size() ? null : this.args.get(index);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
@API( owner = "ComputerCraft", provides = "ComputerCraft|API|Lua", apiVersion = "${version}" )
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.API;
 | 
			
		||||
@@ -3,25 +3,25 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.media;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.filesystem.IMount;
 | 
			
		||||
import net.minecraft.item.Item;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.SoundEvent;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
package dan200.computercraft.api.media;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.filesystem.IMount;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.item.Item;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.sound.SoundEvent;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Represents an item that can be placed in a disk drive and used by a Computer.
 | 
			
		||||
 *
 | 
			
		||||
 * Implement this interface on your {@link Item} class to allow it to be used in the drive. Alternatively, register
 | 
			
		||||
 * a {@link IMediaProvider}.
 | 
			
		||||
 * Implement this interface on your {@link Item} class to allow it to be used in the drive. Alternatively, register a {@link IMediaProvider}.
 | 
			
		||||
 */
 | 
			
		||||
public interface IMedia
 | 
			
		||||
{
 | 
			
		||||
public interface IMedia {
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a string representing the label of this item. Will be called via {@code disk.getLabel()} in lua.
 | 
			
		||||
     *
 | 
			
		||||
@@ -29,7 +29,7 @@ public interface IMedia
 | 
			
		||||
     * @return The label. ie: "Dan's Programs".
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    String getLabel( @Nonnull ItemStack stack );
 | 
			
		||||
    String getLabel(@Nonnull ItemStack stack);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Set a string representing the label of this item. Will be called vi {@code disk.setLabel()} in lua.
 | 
			
		||||
@@ -38,21 +38,18 @@ public interface IMedia
 | 
			
		||||
     * @param label The string to set the label to.
 | 
			
		||||
     * @return true if the label was updated, false if the label may not be modified.
 | 
			
		||||
     */
 | 
			
		||||
    default boolean setLabel( @Nonnull ItemStack stack, @Nullable String label )
 | 
			
		||||
    {
 | 
			
		||||
    default boolean setLabel(@Nonnull ItemStack stack, @Nullable String label) {
 | 
			
		||||
        return false;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * If this disk represents an item with audio (like a record), get the readable name of the audio track. ie:
 | 
			
		||||
     * "Jonathan Coulton - Still Alive"
 | 
			
		||||
     * If this disk represents an item with audio (like a record), get the readable name of the audio track. ie: "Jonathan Coulton - Still Alive"
 | 
			
		||||
     *
 | 
			
		||||
     * @param stack The {@link ItemStack} to modify.
 | 
			
		||||
     * @return The name, or null if this item does not represent an item with audio.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    default String getAudioTitle( @Nonnull ItemStack stack )
 | 
			
		||||
    {
 | 
			
		||||
    default String getAudioTitle(@Nonnull ItemStack stack) {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -63,27 +60,25 @@ public interface IMedia
 | 
			
		||||
     * @return The name, or null if this item does not represent an item with audio.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    default SoundEvent getAudio( @Nonnull ItemStack stack )
 | 
			
		||||
    {
 | 
			
		||||
    default SoundEvent getAudio(@Nonnull ItemStack stack) {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * If this disk represents an item with data (like a floppy disk), get a mount representing it's contents. This will
 | 
			
		||||
     * be mounted onto the filesystem of the computer while the media is in the disk drive.
 | 
			
		||||
     * If this disk represents an item with data (like a floppy disk), get a mount representing it's contents. This will be mounted onto the filesystem of
 | 
			
		||||
     * the computer while the media is in the disk drive.
 | 
			
		||||
     *
 | 
			
		||||
     * @param stack The {@link ItemStack} to modify.
 | 
			
		||||
     * @param world The world in which the item and disk drive reside.
 | 
			
		||||
     * @return The mount, or null if this item does not represent an item with data. If the mount returned also
 | 
			
		||||
     * implements {@link dan200.computercraft.api.filesystem.IWritableMount}, it will mounted using mountWritable()
 | 
			
		||||
     * @return The mount, or null if this item does not represent an item with data. If the mount returned also implements {@link
 | 
			
		||||
     *     dan200.computercraft.api.filesystem.IWritableMount}, it will mounted using mountWritable()
 | 
			
		||||
     * @see IMount
 | 
			
		||||
     * @see dan200.computercraft.api.filesystem.IWritableMount
 | 
			
		||||
     * @see dan200.computercraft.api.ComputerCraftAPI#createSaveDirMount(World, String, long)
 | 
			
		||||
     * @see dan200.computercraft.api.ComputerCraftAPI#createResourceMount(Class, String, String)
 | 
			
		||||
     * @see dan200.computercraft.api.ComputerCraftAPI#createResourceMount(String, String)
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    default IMount createDataMount( @Nonnull ItemStack stack, @Nonnull World world )
 | 
			
		||||
    {
 | 
			
		||||
    default IMount createDataMount(@Nonnull ItemStack stack, @Nonnull World world) {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,21 +3,21 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.media;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
package dan200.computercraft.api.media;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * This interface is used to provide {@link IMedia} implementations for {@link ItemStack}.
 | 
			
		||||
 *
 | 
			
		||||
 * @see dan200.computercraft.api.ComputerCraftAPI#registerMediaProvider(IMediaProvider)
 | 
			
		||||
 */
 | 
			
		||||
@FunctionalInterface
 | 
			
		||||
public interface IMediaProvider
 | 
			
		||||
{
 | 
			
		||||
public interface IMediaProvider {
 | 
			
		||||
    /**
 | 
			
		||||
     * Produce an IMedia implementation from an ItemStack.
 | 
			
		||||
     *
 | 
			
		||||
@@ -26,5 +26,5 @@ public interface IMediaProvider
 | 
			
		||||
     * @see dan200.computercraft.api.ComputerCraftAPI#registerMediaProvider(IMediaProvider)
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    IMedia getMedia( @Nonnull ItemStack stack );
 | 
			
		||||
    IMedia getMedia(@Nonnull ItemStack stack);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
@API( owner = "ComputerCraft", provides = "ComputerCraft|API|Media", apiVersion = "${version}" )
 | 
			
		||||
package dan200.computercraft.api.media;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.API;
 | 
			
		||||
@@ -3,6 +3,7 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.network;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
@@ -13,21 +14,20 @@ import javax.annotation.Nonnull;
 | 
			
		||||
 * @see Packet
 | 
			
		||||
 * @see IPacketReceiver
 | 
			
		||||
 */
 | 
			
		||||
public interface IPacketNetwork
 | 
			
		||||
{
 | 
			
		||||
public interface IPacketNetwork {
 | 
			
		||||
    /**
 | 
			
		||||
     * Add a receiver to the network.
 | 
			
		||||
     *
 | 
			
		||||
     * @param receiver The receiver to register to the network.
 | 
			
		||||
     */
 | 
			
		||||
    void addReceiver( @Nonnull IPacketReceiver receiver );
 | 
			
		||||
    void addReceiver(@Nonnull IPacketReceiver receiver);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Remove a receiver from the network.
 | 
			
		||||
     *
 | 
			
		||||
     * @param receiver The device to remove from the network.
 | 
			
		||||
     */
 | 
			
		||||
    void removeReceiver( @Nonnull IPacketReceiver receiver );
 | 
			
		||||
    void removeReceiver(@Nonnull IPacketReceiver receiver);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Determine whether this network is wireless.
 | 
			
		||||
@@ -37,23 +37,23 @@ public interface IPacketNetwork
 | 
			
		||||
    boolean isWireless();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Submit a packet for transmitting across the network. This will route the packet through the network, sending it
 | 
			
		||||
     * to all receivers within range (or any interdimensional ones).
 | 
			
		||||
     * Submit a packet for transmitting across the network. This will route the packet through the network, sending it to all receivers within range (or any
 | 
			
		||||
     * interdimensional ones).
 | 
			
		||||
     *
 | 
			
		||||
     * @param packet The packet to send.
 | 
			
		||||
     * @param range  The maximum distance this packet will be sent.
 | 
			
		||||
     * @param range The maximum distance this packet will be sent.
 | 
			
		||||
     * @see #transmitInterdimensional(Packet)
 | 
			
		||||
     * @see IPacketReceiver#receiveSameDimension(Packet, double)
 | 
			
		||||
     */
 | 
			
		||||
    void transmitSameDimension( @Nonnull Packet packet, double range );
 | 
			
		||||
    void transmitSameDimension(@Nonnull Packet packet, double range);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Submit a packet for transmitting across the network. This will route the packet through the network, sending it
 | 
			
		||||
     * to all receivers across all dimensions.
 | 
			
		||||
     * Submit a packet for transmitting across the network. This will route the packet through the network, sending it to all receivers across all
 | 
			
		||||
     * dimensions.
 | 
			
		||||
     *
 | 
			
		||||
     * @param packet The packet to send.
 | 
			
		||||
     * @see #transmitSameDimension(Packet, double)
 | 
			
		||||
     * @see IPacketReceiver#receiveDifferentDimension(Packet)
 | 
			
		||||
     */
 | 
			
		||||
    void transmitInterdimensional( @Nonnull Packet packet );
 | 
			
		||||
    void transmitInterdimensional(@Nonnull Packet packet);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,18 +3,18 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.network;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.util.math.Vec3d;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An object on an {@link IPacketNetwork}, capable of receiving packets.
 | 
			
		||||
 */
 | 
			
		||||
public interface IPacketReceiver
 | 
			
		||||
{
 | 
			
		||||
public interface IPacketReceiver {
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the world in which this packet receiver exists.
 | 
			
		||||
     *
 | 
			
		||||
@@ -34,9 +34,8 @@ public interface IPacketReceiver
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the maximum distance this receiver can send and receive messages.
 | 
			
		||||
     *
 | 
			
		||||
     * When determining whether a receiver can receive a message, the largest distance of the packet and receiver is
 | 
			
		||||
     * used - ensuring it is within range. If the packet or receiver is inter-dimensional, then the packet will always
 | 
			
		||||
     * be received.
 | 
			
		||||
     * When determining whether a receiver can receive a message, the largest distance of the packet and receiver is used - ensuring it is within range. If
 | 
			
		||||
     * the packet or receiver is inter-dimensional, then the packet will always be received.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The maximum distance this device can send and receive messages.
 | 
			
		||||
     * @see #isInterdimensional()
 | 
			
		||||
@@ -60,25 +59,25 @@ public interface IPacketReceiver
 | 
			
		||||
    /**
 | 
			
		||||
     * Receive a network packet from the same dimension.
 | 
			
		||||
     *
 | 
			
		||||
     * @param packet   The packet to receive. Generally you should check that you are listening on the given channel and,
 | 
			
		||||
     *                 if so, queue the appropriate modem event.
 | 
			
		||||
     * @param packet The packet to receive. Generally you should check that you are listening on the given channel and, if so, queue the appropriate
 | 
			
		||||
     *     modem event.
 | 
			
		||||
     * @param distance The distance this packet has travelled from the source.
 | 
			
		||||
     * @see Packet
 | 
			
		||||
     * @see #getRange()
 | 
			
		||||
     * @see IPacketNetwork#transmitSameDimension(Packet, double)
 | 
			
		||||
     * @see IPacketNetwork#transmitInterdimensional(Packet)
 | 
			
		||||
     */
 | 
			
		||||
    void receiveSameDimension( @Nonnull Packet packet, double distance );
 | 
			
		||||
    void receiveSameDimension(@Nonnull Packet packet, double distance);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Receive a network packet from a different dimension.
 | 
			
		||||
     *
 | 
			
		||||
     * @param packet The packet to receive. Generally you should check that you are listening on the given channel and,
 | 
			
		||||
     *               if so, queue the appropriate modem event.
 | 
			
		||||
     * @param packet The packet to receive. Generally you should check that you are listening on the given channel and, if so, queue the appropriate
 | 
			
		||||
     *     modem event.
 | 
			
		||||
     * @see Packet
 | 
			
		||||
     * @see IPacketNetwork#transmitInterdimensional(Packet)
 | 
			
		||||
     * @see IPacketNetwork#transmitSameDimension(Packet, double)
 | 
			
		||||
     * @see #isInterdimensional()
 | 
			
		||||
     */
 | 
			
		||||
    void receiveDifferentDimension( @Nonnull Packet packet );
 | 
			
		||||
    void receiveDifferentDimension(@Nonnull Packet packet);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,18 +3,18 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.network;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.util.math.Vec3d;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An object on a {@link IPacketNetwork}, capable of sending packets.
 | 
			
		||||
 */
 | 
			
		||||
public interface IPacketSender
 | 
			
		||||
{
 | 
			
		||||
public interface IPacketSender {
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the world in which this packet sender exists.
 | 
			
		||||
     *
 | 
			
		||||
@@ -32,8 +32,8 @@ public interface IPacketSender
 | 
			
		||||
    Vec3d getPosition();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get some sort of identification string for this sender. This does not strictly need to be unique, but you
 | 
			
		||||
     * should be able to extract some identifiable information from it.
 | 
			
		||||
     * Get some sort of identification string for this sender. This does not strictly need to be unique, but you should be able to extract some identifiable
 | 
			
		||||
     * information from it.
 | 
			
		||||
     *
 | 
			
		||||
     * @return This device's id.
 | 
			
		||||
     */
 | 
			
		||||
 
 | 
			
		||||
@@ -3,11 +3,13 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.network;
 | 
			
		||||
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Represents a packet which may be sent across a {@link IPacketNetwork}.
 | 
			
		||||
@@ -18,8 +20,7 @@ import java.util.Objects;
 | 
			
		||||
 * @see IPacketReceiver#receiveDifferentDimension(Packet)
 | 
			
		||||
 * @see IPacketReceiver#receiveSameDimension(Packet, double)
 | 
			
		||||
 */
 | 
			
		||||
public class Packet
 | 
			
		||||
{
 | 
			
		||||
public class Packet {
 | 
			
		||||
    private final int channel;
 | 
			
		||||
    private final int replyChannel;
 | 
			
		||||
    private final Object payload;
 | 
			
		||||
@@ -29,16 +30,14 @@ public class Packet
 | 
			
		||||
    /**
 | 
			
		||||
     * Create a new packet, ready for transmitting across the network.
 | 
			
		||||
     *
 | 
			
		||||
     * @param channel      The channel to send the packet along. Receiving devices should only process packets from on
 | 
			
		||||
     *                     channels they are listening to.
 | 
			
		||||
     * @param channel The channel to send the packet along. Receiving devices should only process packets from on channels they are listening to.
 | 
			
		||||
     * @param replyChannel The channel to reply on.
 | 
			
		||||
     * @param payload      The contents of this packet. This should be a "valid" Lua object, safe for queuing as an
 | 
			
		||||
     *                     event or returning from a peripheral call.
 | 
			
		||||
     * @param sender       The object which sent this packet.
 | 
			
		||||
     * @param payload The contents of this packet. This should be a "valid" Lua object, safe for queuing as an event or returning from a peripheral
 | 
			
		||||
     *     call.
 | 
			
		||||
     * @param sender The object which sent this packet.
 | 
			
		||||
     */
 | 
			
		||||
    public Packet( int channel, int replyChannel, @Nullable Object payload, @Nonnull IPacketSender sender )
 | 
			
		||||
    {
 | 
			
		||||
        Objects.requireNonNull( sender, "sender cannot be null" );
 | 
			
		||||
    public Packet(int channel, int replyChannel, @Nullable Object payload, @Nonnull IPacketSender sender) {
 | 
			
		||||
        Objects.requireNonNull(sender, "sender cannot be null");
 | 
			
		||||
 | 
			
		||||
        this.channel = channel;
 | 
			
		||||
        this.replyChannel = replyChannel;
 | 
			
		||||
@@ -47,14 +46,12 @@ public class Packet
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the channel this packet is sent along. Receivers should generally only process packets from on channels they
 | 
			
		||||
     * are listening to.
 | 
			
		||||
     * Get the channel this packet is sent along. Receivers should generally only process packets from on channels they are listening to.
 | 
			
		||||
     *
 | 
			
		||||
     * @return This packet's channel.
 | 
			
		||||
     */
 | 
			
		||||
    public int getChannel()
 | 
			
		||||
    {
 | 
			
		||||
        return channel;
 | 
			
		||||
    public int getChannel() {
 | 
			
		||||
        return this.channel;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -62,21 +59,18 @@ public class Packet
 | 
			
		||||
     *
 | 
			
		||||
     * @return This channel to reply on.
 | 
			
		||||
     */
 | 
			
		||||
    public int getReplyChannel()
 | 
			
		||||
    {
 | 
			
		||||
        return replyChannel;
 | 
			
		||||
    public int getReplyChannel() {
 | 
			
		||||
        return this.replyChannel;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * The actual data of this packet. This should be a "valid" Lua object, safe for queuing as an
 | 
			
		||||
     * event or returning from a peripheral call.
 | 
			
		||||
     * The actual data of this packet. This should be a "valid" Lua object, safe for queuing as an event or returning from a peripheral call.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The packet's payload
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public Object getPayload()
 | 
			
		||||
    {
 | 
			
		||||
        return payload;
 | 
			
		||||
    public Object getPayload() {
 | 
			
		||||
        return this.payload;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -85,33 +79,40 @@ public class Packet
 | 
			
		||||
     * @return The sending object.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public IPacketSender getSender()
 | 
			
		||||
    {
 | 
			
		||||
        return sender;
 | 
			
		||||
    public IPacketSender getSender() {
 | 
			
		||||
        return this.sender;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public boolean equals( Object o )
 | 
			
		||||
    {
 | 
			
		||||
        if( this == o ) return true;
 | 
			
		||||
        if( o == null || getClass() != o.getClass() ) return false;
 | 
			
		||||
    public int hashCode() {
 | 
			
		||||
        int result;
 | 
			
		||||
        result = this.channel;
 | 
			
		||||
        result = 31 * result + this.replyChannel;
 | 
			
		||||
        result = 31 * result + (this.payload != null ? this.payload.hashCode() : 0);
 | 
			
		||||
        result = 31 * result + this.sender.hashCode();
 | 
			
		||||
        return result;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public boolean equals(Object o) {
 | 
			
		||||
        if (this == o) {
 | 
			
		||||
            return true;
 | 
			
		||||
        }
 | 
			
		||||
        if (o == null || this.getClass() != o.getClass()) {
 | 
			
		||||
            return false;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        Packet packet = (Packet) o;
 | 
			
		||||
 | 
			
		||||
        if( channel != packet.channel ) return false;
 | 
			
		||||
        if( replyChannel != packet.replyChannel ) return false;
 | 
			
		||||
        if( !Objects.equals( payload, packet.payload ) ) return false;
 | 
			
		||||
        return sender.equals( packet.sender );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public int hashCode()
 | 
			
		||||
    {
 | 
			
		||||
        int result;
 | 
			
		||||
        result = channel;
 | 
			
		||||
        result = 31 * result + replyChannel;
 | 
			
		||||
        result = 31 * result + (payload != null ? payload.hashCode() : 0);
 | 
			
		||||
        result = 31 * result + sender.hashCode();
 | 
			
		||||
        return result;
 | 
			
		||||
        if (this.channel != packet.channel) {
 | 
			
		||||
            return false;
 | 
			
		||||
        }
 | 
			
		||||
        if (this.replyChannel != packet.replyChannel) {
 | 
			
		||||
            return false;
 | 
			
		||||
        }
 | 
			
		||||
        if (!Objects.equals(this.payload, packet.payload)) {
 | 
			
		||||
            return false;
 | 
			
		||||
        }
 | 
			
		||||
        return this.sender.equals(packet.sender);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
@API( owner = "ComputerCraft", provides = "ComputerCraft|API|Network", apiVersion = "${version}" )
 | 
			
		||||
package dan200.computercraft.api.network;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.API;
 | 
			
		||||
@@ -3,32 +3,29 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.network.wired;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An object which may be part of a wired network.
 | 
			
		||||
 *
 | 
			
		||||
 * Elements should construct a node using {@link ComputerCraftAPI#createWiredNodeForElement(IWiredElement)}. This acts
 | 
			
		||||
 * as a proxy for all network objects. Whilst the node may change networks, an element's node should remain constant
 | 
			
		||||
 * for its lifespan.
 | 
			
		||||
 * Elements should construct a node using {@link ComputerCraftAPI#createWiredNodeForElement(IWiredElement)}. This acts as a proxy for all network objects.
 | 
			
		||||
 * Whilst the node may change networks, an element's node should remain constant for its lifespan.
 | 
			
		||||
 *
 | 
			
		||||
 * Elements are generally tied to a block or tile entity in world. In such as case, one should provide the
 | 
			
		||||
 * {@link IWiredElement} capability for the appropriate sides.
 | 
			
		||||
 * Elements are generally tied to a block or tile entity in world. In such as case, one should provide the {@link IWiredElement} capability for the
 | 
			
		||||
 * appropriate sides.
 | 
			
		||||
 */
 | 
			
		||||
public interface IWiredElement extends IWiredSender
 | 
			
		||||
{
 | 
			
		||||
public interface IWiredElement extends IWiredSender {
 | 
			
		||||
    /**
 | 
			
		||||
     * Called when objects on the network change. This may occur when network nodes are added or removed, or when
 | 
			
		||||
     * peripherals change.
 | 
			
		||||
     * Called when objects on the network change. This may occur when network nodes are added or removed, or when peripherals change.
 | 
			
		||||
     *
 | 
			
		||||
     * @param change The change which occurred.
 | 
			
		||||
     * @see IWiredNetworkChange
 | 
			
		||||
     */
 | 
			
		||||
    default void networkChanged( @Nonnull IWiredNetworkChange change )
 | 
			
		||||
    {
 | 
			
		||||
    default void networkChanged(@Nonnull IWiredNetworkChange change) {
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,50 +3,49 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.network.wired;
 | 
			
		||||
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A wired network is composed of one of more {@link IWiredNode}s, a set of connections between them, and a series
 | 
			
		||||
 * of peripherals.
 | 
			
		||||
 * A wired network is composed of one of more {@link IWiredNode}s, a set of connections between them, and a series of peripherals.
 | 
			
		||||
 *
 | 
			
		||||
 * Networks from a connected graph. This means there is some path between all nodes on the network. Further more, if
 | 
			
		||||
 * there is some path between two nodes then they must be on the same network. {@link IWiredNetwork} will automatically
 | 
			
		||||
 * handle the merging and splitting of networks (and thus changing of available nodes and peripherals) as connections
 | 
			
		||||
 * change.
 | 
			
		||||
 * Networks from a connected graph. This means there is some path between all nodes on the network. Further more, if there is some path between two nodes
 | 
			
		||||
 * then they must be on the same network. {@link IWiredNetwork} will automatically handle the merging and splitting of networks (and thus changing of
 | 
			
		||||
 * available nodes and peripherals) as connections change.
 | 
			
		||||
 *
 | 
			
		||||
 * This does mean one can not rely on the network remaining consistent between subsequent operations. Consequently,
 | 
			
		||||
 * it is generally preferred to use the methods provided by {@link IWiredNode}.
 | 
			
		||||
 * This does mean one can not rely on the network remaining consistent between subsequent operations. Consequently, it is generally preferred to use the
 | 
			
		||||
 * methods provided by {@link IWiredNode}.
 | 
			
		||||
 *
 | 
			
		||||
 * @see IWiredNode#getNetwork()
 | 
			
		||||
 */
 | 
			
		||||
public interface IWiredNetwork
 | 
			
		||||
{
 | 
			
		||||
public interface IWiredNetwork {
 | 
			
		||||
    /**
 | 
			
		||||
     * Create a connection between two nodes.
 | 
			
		||||
     *
 | 
			
		||||
     * This should only be used on the server thread.
 | 
			
		||||
     *
 | 
			
		||||
     * @param left  The first node to connect
 | 
			
		||||
     * @param left The first node to connect
 | 
			
		||||
     * @param right The second node to connect
 | 
			
		||||
     * @return {@code true} if a connection was created or {@code false} if the connection already exists.
 | 
			
		||||
     * @throws IllegalStateException    If neither node is on the network.
 | 
			
		||||
     * @throws IllegalStateException If neither node is on the network.
 | 
			
		||||
     * @throws IllegalArgumentException If {@code left} and {@code right} are equal.
 | 
			
		||||
     * @see IWiredNode#connectTo(IWiredNode)
 | 
			
		||||
     * @see IWiredNetwork#connect(IWiredNode, IWiredNode)
 | 
			
		||||
     */
 | 
			
		||||
    boolean connect( @Nonnull IWiredNode left, @Nonnull IWiredNode right );
 | 
			
		||||
    boolean connect(@Nonnull IWiredNode left, @Nonnull IWiredNode right);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Destroy a connection between this node and another.
 | 
			
		||||
     *
 | 
			
		||||
     * This should only be used on the server thread.
 | 
			
		||||
     *
 | 
			
		||||
     * @param left  The first node in the connection.
 | 
			
		||||
     * @param left The first node in the connection.
 | 
			
		||||
     * @param right The second node in the connection.
 | 
			
		||||
     * @return {@code true} if a connection was destroyed or {@code false} if no connection exists.
 | 
			
		||||
     * @throws IllegalArgumentException If either node is not on the network.
 | 
			
		||||
@@ -54,32 +53,29 @@ public interface IWiredNetwork
 | 
			
		||||
     * @see IWiredNode#disconnectFrom(IWiredNode)
 | 
			
		||||
     * @see IWiredNetwork#connect(IWiredNode, IWiredNode)
 | 
			
		||||
     */
 | 
			
		||||
    boolean disconnect( @Nonnull IWiredNode left, @Nonnull IWiredNode right );
 | 
			
		||||
    boolean disconnect(@Nonnull IWiredNode left, @Nonnull IWiredNode right);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Sever all connections this node has, removing it from this network.
 | 
			
		||||
     *
 | 
			
		||||
     * This should only be used on the server thread. You should only call this on nodes
 | 
			
		||||
     * that your network element owns.
 | 
			
		||||
     * This should only be used on the server thread. You should only call this on nodes that your network element owns.
 | 
			
		||||
     *
 | 
			
		||||
     * @param node The node to remove
 | 
			
		||||
     * @return Whether this node was removed from the network. One cannot remove a node from a network where it is the
 | 
			
		||||
     * only element.
 | 
			
		||||
     * @return Whether this node was removed from the network. One cannot remove a node from a network where it is the only element.
 | 
			
		||||
     * @throws IllegalArgumentException If the node is not in the network.
 | 
			
		||||
     * @see IWiredNode#remove()
 | 
			
		||||
     */
 | 
			
		||||
    boolean remove( @Nonnull IWiredNode node );
 | 
			
		||||
    boolean remove(@Nonnull IWiredNode node);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Update the peripherals a node provides.
 | 
			
		||||
     *
 | 
			
		||||
     * This should only be used on the server thread. You should only call this on nodes
 | 
			
		||||
     * that your network element owns.
 | 
			
		||||
     * This should only be used on the server thread. You should only call this on nodes that your network element owns.
 | 
			
		||||
     *
 | 
			
		||||
     * @param node        The node to attach peripherals for.
 | 
			
		||||
     * @param node The node to attach peripherals for.
 | 
			
		||||
     * @param peripherals The new peripherals for this node.
 | 
			
		||||
     * @throws IllegalArgumentException If the node is not in the network.
 | 
			
		||||
     * @see IWiredNode#updatePeripherals(Map)
 | 
			
		||||
     */
 | 
			
		||||
    void updatePeripherals( @Nonnull IWiredNode node, @Nonnull Map<String, IPeripheral> peripherals );
 | 
			
		||||
    void updatePeripherals(@Nonnull IWiredNode node, @Nonnull Map<String, IPeripheral> peripherals);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,23 +3,24 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.network.wired;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Represents a change to the objects on a wired network.
 | 
			
		||||
 *
 | 
			
		||||
 * @see IWiredElement#networkChanged(IWiredNetworkChange)
 | 
			
		||||
 */
 | 
			
		||||
public interface IWiredNetworkChange
 | 
			
		||||
{
 | 
			
		||||
public interface IWiredNetworkChange {
 | 
			
		||||
    /**
 | 
			
		||||
     * A set of peripherals which have been removed. Note that there may be entries with the same name
 | 
			
		||||
     * in the added and removed set, but with a different peripheral.
 | 
			
		||||
     * A set of peripherals which have been removed. Note that there may be entries with the same name in the added and removed set, but with a different
 | 
			
		||||
     * peripheral.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The set of removed peripherals.
 | 
			
		||||
     */
 | 
			
		||||
@@ -27,8 +28,8 @@ public interface IWiredNetworkChange
 | 
			
		||||
    Map<String, IPeripheral> peripheralsRemoved();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * A set of peripherals which have been added. Note that there may be entries with the same name
 | 
			
		||||
     * in the added and removed set, but with a different peripheral.
 | 
			
		||||
     * A set of peripherals which have been added. Note that there may be entries with the same name in the added and removed set, but with a different
 | 
			
		||||
     * peripheral.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The set of added peripherals.
 | 
			
		||||
     */
 | 
			
		||||
 
 | 
			
		||||
@@ -3,29 +3,29 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.network.wired;
 | 
			
		||||
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.network.IPacketNetwork;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Wired nodes act as a layer between {@link IWiredElement}s and {@link IWiredNetwork}s.
 | 
			
		||||
 *
 | 
			
		||||
 * Firstly, a node acts as a packet network, capable of sending and receiving modem messages to connected nodes. These
 | 
			
		||||
 * methods may be safely used on any thread.
 | 
			
		||||
 * Firstly, a node acts as a packet network, capable of sending and receiving modem messages to connected nodes. These methods may be safely used on any
 | 
			
		||||
 * thread.
 | 
			
		||||
 *
 | 
			
		||||
 * When sending a packet, the system will attempt to find the shortest path between the two nodes based on their
 | 
			
		||||
 * element's position. Note that packet senders and receivers can have different locations from their associated
 | 
			
		||||
 * element: the distance between the two will be added to the total packet's distance.
 | 
			
		||||
 * When sending a packet, the system will attempt to find the shortest path between the two nodes based on their element's position. Note that packet
 | 
			
		||||
 * senders and receivers can have different locations from their associated element: the distance between the two will be added to the total packet's
 | 
			
		||||
 * distance.
 | 
			
		||||
 *
 | 
			
		||||
 * Wired nodes also provide several convenience methods for interacting with a wired network. These should only ever
 | 
			
		||||
 * be used on the main server thread.
 | 
			
		||||
 * Wired nodes also provide several convenience methods for interacting with a wired network. These should only ever be used on the main server thread.
 | 
			
		||||
 */
 | 
			
		||||
public interface IWiredNode extends IPacketNetwork
 | 
			
		||||
{
 | 
			
		||||
public interface IWiredNode extends IPacketNetwork {
 | 
			
		||||
    /**
 | 
			
		||||
     * The associated element for this network node.
 | 
			
		||||
     *
 | 
			
		||||
@@ -34,17 +34,6 @@ public interface IWiredNode extends IPacketNetwork
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    IWiredElement getElement();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * The network this node is currently connected to. Note that this may change
 | 
			
		||||
     * after any network operation, so it should not be cached.
 | 
			
		||||
     *
 | 
			
		||||
     * This should only be used on the server thread.
 | 
			
		||||
     *
 | 
			
		||||
     * @return This node's network.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    IWiredNetwork getNetwork();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Create a connection from this node to another.
 | 
			
		||||
     *
 | 
			
		||||
@@ -55,11 +44,20 @@ public interface IWiredNode extends IPacketNetwork
 | 
			
		||||
     * @see IWiredNetwork#connect(IWiredNode, IWiredNode)
 | 
			
		||||
     * @see IWiredNode#disconnectFrom(IWiredNode)
 | 
			
		||||
     */
 | 
			
		||||
    default boolean connectTo( @Nonnull IWiredNode node )
 | 
			
		||||
    {
 | 
			
		||||
        return getNetwork().connect( this, node );
 | 
			
		||||
    default boolean connectTo(@Nonnull IWiredNode node) {
 | 
			
		||||
        return this.getNetwork().connect(this, node);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * The network this node is currently connected to. Note that this may change after any network operation, so it should not be cached.
 | 
			
		||||
     *
 | 
			
		||||
     * This should only be used on the server thread.
 | 
			
		||||
     *
 | 
			
		||||
     * @return This node's network.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    IWiredNetwork getNetwork();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Destroy a connection between this node and another.
 | 
			
		||||
     *
 | 
			
		||||
@@ -71,38 +69,32 @@ public interface IWiredNode extends IPacketNetwork
 | 
			
		||||
     * @see IWiredNetwork#disconnect(IWiredNode, IWiredNode)
 | 
			
		||||
     * @see IWiredNode#connectTo(IWiredNode)
 | 
			
		||||
     */
 | 
			
		||||
    default boolean disconnectFrom( @Nonnull IWiredNode node )
 | 
			
		||||
    {
 | 
			
		||||
        return getNetwork().disconnect( this, node );
 | 
			
		||||
    default boolean disconnectFrom(@Nonnull IWiredNode node) {
 | 
			
		||||
        return this.getNetwork().disconnect(this, node);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Sever all connections this node has, removing it from this network.
 | 
			
		||||
     *
 | 
			
		||||
     * This should only be used on the server thread. You should only call this on nodes
 | 
			
		||||
     * that your network element owns.
 | 
			
		||||
     * This should only be used on the server thread. You should only call this on nodes that your network element owns.
 | 
			
		||||
     *
 | 
			
		||||
     * @return Whether this node was removed from the network. One cannot remove a node from a network where it is the
 | 
			
		||||
     * only element.
 | 
			
		||||
     * @return Whether this node was removed from the network. One cannot remove a node from a network where it is the only element.
 | 
			
		||||
     * @throws IllegalArgumentException If the node is not in the network.
 | 
			
		||||
     * @see IWiredNetwork#remove(IWiredNode)
 | 
			
		||||
     */
 | 
			
		||||
    default boolean remove()
 | 
			
		||||
    {
 | 
			
		||||
        return getNetwork().remove( this );
 | 
			
		||||
    default boolean remove() {
 | 
			
		||||
        return this.getNetwork().remove(this);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Mark this node's peripherals as having changed.
 | 
			
		||||
     *
 | 
			
		||||
     * This should only be used on the server thread. You should only call this on nodes
 | 
			
		||||
     * that your network element owns.
 | 
			
		||||
     * This should only be used on the server thread. You should only call this on nodes that your network element owns.
 | 
			
		||||
     *
 | 
			
		||||
     * @param peripherals The new peripherals for this node.
 | 
			
		||||
     * @see IWiredNetwork#updatePeripherals(IWiredNode, Map)
 | 
			
		||||
     */
 | 
			
		||||
    default void updatePeripherals( @Nonnull Map<String, IPeripheral> peripherals )
 | 
			
		||||
    {
 | 
			
		||||
        getNetwork().updatePeripherals( this, peripherals );
 | 
			
		||||
    default void updatePeripherals(@Nonnull Map<String, IPeripheral> peripherals) {
 | 
			
		||||
        this.getNetwork().updatePeripherals(this, peripherals);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,25 +3,23 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.network.wired;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.network.IPacketSender;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.network.IPacketSender;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An object on a {@link IWiredNetwork} capable of sending packets.
 | 
			
		||||
 *
 | 
			
		||||
 * Unlike a regular {@link IPacketSender}, this must be associated with the node you are attempting to
 | 
			
		||||
 * to send the packet from.
 | 
			
		||||
 * Unlike a regular {@link IPacketSender}, this must be associated with the node you are attempting to to send the packet from.
 | 
			
		||||
 */
 | 
			
		||||
public interface IWiredSender extends IPacketSender
 | 
			
		||||
{
 | 
			
		||||
public interface IWiredSender extends IPacketSender {
 | 
			
		||||
    /**
 | 
			
		||||
     * The node in the network representing this object.
 | 
			
		||||
     *
 | 
			
		||||
     * This should be used as a proxy for the main network. One should send packets
 | 
			
		||||
     * and register receivers through this object.
 | 
			
		||||
     * This should be used as a proxy for the main network. One should send packets and register receivers through this object.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The node for this element.
 | 
			
		||||
     */
 | 
			
		||||
 
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
@API( owner = "ComputerCraft", provides = "ComputerCraft|API|Network|Wired", apiVersion = "${version}" )
 | 
			
		||||
package dan200.computercraft.api.network.wired;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.API;
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
@API( owner = "ComputerCraft", provides = "ComputerCraft|API", apiVersion = "${version}" )
 | 
			
		||||
package dan200.computercraft.api;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.API;
 | 
			
		||||
@@ -3,166 +3,158 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.api.filesystem.IMount;
 | 
			
		||||
import dan200.computercraft.api.filesystem.IWritableMount;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaCallback;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaContext;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaTask;
 | 
			
		||||
import dan200.computercraft.api.lua.MethodResult;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.Collections;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The interface passed to peripherals by computers or turtles, providing methods
 | 
			
		||||
 * that they can call. This should not be implemented by your classes. Do not interact
 | 
			
		||||
 * with computers except via this interface.
 | 
			
		||||
 * The interface passed to peripherals by computers or turtles, providing methods that they can call. This should not be implemented by your classes. Do not
 | 
			
		||||
 * interact with computers except via this interface.
 | 
			
		||||
 */
 | 
			
		||||
public interface IComputerAccess
 | 
			
		||||
{
 | 
			
		||||
public interface IComputerAccess {
 | 
			
		||||
    /**
 | 
			
		||||
     * Mount a mount onto the computer's file system in a read only mode.
 | 
			
		||||
     *
 | 
			
		||||
     * @param desiredLocation The location on the computer's file system where you would like the mount to be mounted.
 | 
			
		||||
     * @param mount           The mount object to mount on the computer.
 | 
			
		||||
     * @return The location on the computer's file system where you the mount mounted, or {@code null} if there was already a
 | 
			
		||||
     * file in the desired location. Store this value if you wish to unmount the mount later.
 | 
			
		||||
     * @throws RuntimeException If the peripheral has been detached.
 | 
			
		||||
     * @param mount The mount object to mount on the computer.
 | 
			
		||||
     * @return The location on the computer's file system where you the mount mounted, or {@code null} if there was already a file in the desired location.
 | 
			
		||||
     *     Store this value if you wish to unmount the mount later.
 | 
			
		||||
     * @throws NotAttachedException If the peripheral has been detached.
 | 
			
		||||
     * @see ComputerCraftAPI#createSaveDirMount(World, String, long)
 | 
			
		||||
     * @see ComputerCraftAPI#createResourceMount(Class, String, String)
 | 
			
		||||
     * @see ComputerCraftAPI#createResourceMount(String, String)
 | 
			
		||||
     * @see #mount(String, IMount, String)
 | 
			
		||||
     * @see #mountWritable(String, IWritableMount)
 | 
			
		||||
     * @see #unmount(String)
 | 
			
		||||
     * @see IMount
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    default String mount( @Nonnull String desiredLocation, @Nonnull IMount mount )
 | 
			
		||||
    {
 | 
			
		||||
        return mount( desiredLocation, mount, getAttachmentName() );
 | 
			
		||||
    default String mount(@Nonnull String desiredLocation, @Nonnull IMount mount) {
 | 
			
		||||
        return this.mount(desiredLocation, mount, this.getAttachmentName());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Mount a mount onto the computer's file system in a read only mode.
 | 
			
		||||
     *
 | 
			
		||||
     * @param desiredLocation The location on the computer's file system where you would like the mount to be mounted.
 | 
			
		||||
     * @param mount           The mount object to mount on the computer.
 | 
			
		||||
     * @param driveName       A custom name to give for this mount location, as returned by {@code fs.getDrive()}.
 | 
			
		||||
     * @return The location on the computer's file system where you the mount mounted, or {@code null} if there was already a
 | 
			
		||||
     * file in the desired location. Store this value if you wish to unmount the mount later.
 | 
			
		||||
     * @throws RuntimeException If the peripheral has been detached.
 | 
			
		||||
     * @param mount The mount object to mount on the computer.
 | 
			
		||||
     * @param driveName A custom name to give for this mount location, as returned by {@code fs.getDrive()}.
 | 
			
		||||
     * @return The location on the computer's file system where you the mount mounted, or {@code null} if there was already a file in the desired location.
 | 
			
		||||
     *     Store this value if you wish to unmount the mount later.
 | 
			
		||||
     * @throws NotAttachedException If the peripheral has been detached.
 | 
			
		||||
     * @see ComputerCraftAPI#createSaveDirMount(World, String, long)
 | 
			
		||||
     * @see ComputerCraftAPI#createResourceMount(Class, String, String)
 | 
			
		||||
     * @see ComputerCraftAPI#createResourceMount(String, String)
 | 
			
		||||
     * @see #mount(String, IMount)
 | 
			
		||||
     * @see #mountWritable(String, IWritableMount)
 | 
			
		||||
     * @see #unmount(String)
 | 
			
		||||
     * @see IMount
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    String mount( @Nonnull String desiredLocation, @Nonnull IMount mount, @Nonnull String driveName );
 | 
			
		||||
    String mount(@Nonnull String desiredLocation, @Nonnull IMount mount, @Nonnull String driveName);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a string, unique to the computer, by which the computer refers to this peripheral. For directly attached peripherals this will be
 | 
			
		||||
     * "left","right","front","back",etc, but for peripherals attached remotely it will be different. It is good practice to supply this string when raising
 | 
			
		||||
     * events to the computer, so that the computer knows from which peripheral the event came.
 | 
			
		||||
     *
 | 
			
		||||
     * @return A string unique to the computer, but not globally.
 | 
			
		||||
     * @throws NotAttachedException If the peripheral has been detached.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    String getAttachmentName();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Mount a mount onto the computer's file system in a writable mode.
 | 
			
		||||
     *
 | 
			
		||||
     * @param desiredLocation The location on the computer's file system where you would like the mount to be mounted.
 | 
			
		||||
     * @param mount           The mount object to mount on the computer.
 | 
			
		||||
     * @return The location on the computer's file system where you the mount mounted, or null if there was already a
 | 
			
		||||
     * file in the desired location. Store this value if you wish to unmount the mount later.
 | 
			
		||||
     * @throws RuntimeException If the peripheral has been detached.
 | 
			
		||||
     * @param mount The mount object to mount on the computer.
 | 
			
		||||
     * @return The location on the computer's file system where you the mount mounted, or null if there was already a file in the desired location. Store
 | 
			
		||||
     *     this value if you wish to unmount the mount later.
 | 
			
		||||
     * @throws NotAttachedException If the peripheral has been detached.
 | 
			
		||||
     * @see ComputerCraftAPI#createSaveDirMount(World, String, long)
 | 
			
		||||
     * @see ComputerCraftAPI#createResourceMount(Class, String, String)
 | 
			
		||||
     * @see ComputerCraftAPI#createResourceMount(String, String)
 | 
			
		||||
     * @see #mount(String, IMount)
 | 
			
		||||
     * @see #unmount(String)
 | 
			
		||||
     * @see IMount
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    default String mountWritable( @Nonnull String desiredLocation, @Nonnull IWritableMount mount )
 | 
			
		||||
    {
 | 
			
		||||
        return mountWritable( desiredLocation, mount, getAttachmentName() );
 | 
			
		||||
    default String mountWritable(@Nonnull String desiredLocation, @Nonnull IWritableMount mount) {
 | 
			
		||||
        return this.mountWritable(desiredLocation, mount, this.getAttachmentName());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Mount a mount onto the computer's file system in a writable mode.
 | 
			
		||||
     *
 | 
			
		||||
     * @param desiredLocation The location on the computer's file system where you would like the mount to be mounted.
 | 
			
		||||
     * @param mount           The mount object to mount on the computer.
 | 
			
		||||
     * @param driveName       A custom name to give for this mount location, as returned by {@code fs.getDrive()}.
 | 
			
		||||
     * @return The location on the computer's file system where you the mount mounted, or null if there was already a
 | 
			
		||||
     * file in the desired location. Store this value if you wish to unmount the mount later.
 | 
			
		||||
     * @throws RuntimeException If the peripheral has been detached.
 | 
			
		||||
     * @param mount The mount object to mount on the computer.
 | 
			
		||||
     * @param driveName A custom name to give for this mount location, as returned by {@code fs.getDrive()}.
 | 
			
		||||
     * @return The location on the computer's file system where you the mount mounted, or null if there was already a file in the desired location. Store
 | 
			
		||||
     *     this value if you wish to unmount the mount later.
 | 
			
		||||
     * @throws NotAttachedException If the peripheral has been detached.
 | 
			
		||||
     * @see ComputerCraftAPI#createSaveDirMount(World, String, long)
 | 
			
		||||
     * @see ComputerCraftAPI#createResourceMount(Class, String, String)
 | 
			
		||||
     * @see ComputerCraftAPI#createResourceMount(String, String)
 | 
			
		||||
     * @see #mount(String, IMount)
 | 
			
		||||
     * @see #unmount(String)
 | 
			
		||||
     * @see IMount
 | 
			
		||||
     */
 | 
			
		||||
    String mountWritable( @Nonnull String desiredLocation, @Nonnull IWritableMount mount, @Nonnull String driveName );
 | 
			
		||||
    String mountWritable(@Nonnull String desiredLocation, @Nonnull IWritableMount mount, @Nonnull String driveName);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Unmounts a directory previously mounted onto the computers file system by {@link #mount(String, IMount)}
 | 
			
		||||
     * or {@link #mountWritable(String, IWritableMount)}.
 | 
			
		||||
     * Unmounts a directory previously mounted onto the computers file system by {@link #mount(String, IMount)} or {@link #mountWritable(String,
 | 
			
		||||
     * IWritableMount)}.
 | 
			
		||||
     *
 | 
			
		||||
     * When a directory is unmounted, it will disappear from the computers file system, and the user will no longer be
 | 
			
		||||
     * able to access it. All directories mounted by a mount or mountWritable are automatically unmounted when the
 | 
			
		||||
     * peripheral is attached if they have not been explicitly unmounted.
 | 
			
		||||
     * When a directory is unmounted, it will disappear from the computers file system, and the user will no longer be able to access it. All directories
 | 
			
		||||
     * mounted by a mount or mountWritable are automatically unmounted when the peripheral is attached if they have not been explicitly unmounted.
 | 
			
		||||
     *
 | 
			
		||||
     * Note that you cannot unmount another peripheral's mounts.
 | 
			
		||||
     *
 | 
			
		||||
     * @param location The desired location in the computers file system of the directory to unmount.
 | 
			
		||||
     *                 This must be the location of a directory previously mounted by {@link #mount(String, IMount)} or
 | 
			
		||||
     *                 {@link #mountWritable(String, IWritableMount)}, as indicated by their return value.
 | 
			
		||||
     * @throws RuntimeException If the peripheral has been detached.
 | 
			
		||||
     * @throws RuntimeException If the mount does not exist, or was mounted by another peripheral.
 | 
			
		||||
     * @param location The desired location in the computers file system of the directory to unmount. This must be the location of a directory
 | 
			
		||||
     *     previously mounted by {@link #mount(String, IMount)} or {@link #mountWritable(String, IWritableMount)}, as indicated by their return value.
 | 
			
		||||
     * @throws NotAttachedException If the peripheral has been detached.
 | 
			
		||||
     * @throws IllegalStateException If the mount does not exist, or was mounted by another peripheral.
 | 
			
		||||
     * @see #mount(String, IMount)
 | 
			
		||||
     * @see #mountWritable(String, IWritableMount)
 | 
			
		||||
     */
 | 
			
		||||
    void unmount( @Nullable String location );
 | 
			
		||||
    void unmount(@Nullable String location);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the numerical ID of this computer.
 | 
			
		||||
     *
 | 
			
		||||
     * This is the same number obtained by calling {@code os.getComputerID()} or running the "id" program from lua,
 | 
			
		||||
     * and is guaranteed unique. This number will be positive.
 | 
			
		||||
     * This is the same number obtained by calling {@code os.getComputerID()} or running the "id" program from lua, and is guaranteed unique. This number
 | 
			
		||||
     * will be positive.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The identifier.
 | 
			
		||||
     */
 | 
			
		||||
    int getID();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Causes an event to be raised on this computer, which the computer can respond to by calling
 | 
			
		||||
     * {@code os.pullEvent()}. This can be used to notify the computer when things happen in the world or to
 | 
			
		||||
     * this peripheral.
 | 
			
		||||
     * Causes an event to be raised on this computer, which the computer can respond to by calling {@code os.pullEvent()}. This can be used to notify the
 | 
			
		||||
     * computer when things happen in the world or to this peripheral.
 | 
			
		||||
     *
 | 
			
		||||
     * @param event     A string identifying the type of event that has occurred, this will be
 | 
			
		||||
     *                  returned as the first value from {@code os.pullEvent()}. It is recommended that you
 | 
			
		||||
     *                  you choose a name that is unique, and recognisable as originating from your
 | 
			
		||||
     *                  peripheral. eg: If your peripheral type is "button", a suitable event would be
 | 
			
		||||
     *                  "button_pressed".
 | 
			
		||||
     * @param arguments In addition to a name, you may pass an array of extra arguments to the event, that will
 | 
			
		||||
     *                  be supplied as extra return values to os.pullEvent(). Objects in the array will be converted
 | 
			
		||||
     *                  to lua data types in the same fashion as the return values of IPeripheral.callMethod().
 | 
			
		||||
     * @param event A string identifying the type of event that has occurred, this will be returned as the first value from {@code os.pullEvent()}. It
 | 
			
		||||
     *     is recommended that you you choose a name that is unique, and recognisable as originating from your peripheral. eg: If your peripheral type is
 | 
			
		||||
     *     "button", a suitable event would be "button_pressed".
 | 
			
		||||
     * @param arguments In addition to a name, you may pass an array of extra arguments to the event, that will be supplied as extra return values to
 | 
			
		||||
     *     os.pullEvent(). Objects in the array will be converted to lua data types in the same fashion as the return values of IPeripheral.callMethod().
 | 
			
		||||
     *
 | 
			
		||||
     *                  You may supply {@code null} to indicate that no arguments are to be supplied.
 | 
			
		||||
     * @throws RuntimeException If the peripheral has been detached.
 | 
			
		||||
     * @see IPeripheral#callMethod
 | 
			
		||||
     *     You may supply {@code null} to indicate that no arguments are to be supplied.
 | 
			
		||||
     * @throws NotAttachedException If the peripheral has been detached.
 | 
			
		||||
     * @see MethodResult#pullEvent(String, ILuaCallback)
 | 
			
		||||
     */
 | 
			
		||||
    void queueEvent( @Nonnull String event, @Nullable Object[] arguments );
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a string, unique to the computer, by which the computer refers to this peripheral.
 | 
			
		||||
     * For directly attached peripherals this will be "left","right","front","back",etc, but
 | 
			
		||||
     * for peripherals attached remotely it will be different. It is good practice to supply
 | 
			
		||||
     * this string when raising events to the computer, so that the computer knows from
 | 
			
		||||
     * which peripheral the event came.
 | 
			
		||||
     *
 | 
			
		||||
     * @return A string unique to the computer, but not globally.
 | 
			
		||||
     * @throws RuntimeException If the peripheral has been detached.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    String getAttachmentName();
 | 
			
		||||
    void queueEvent(@Nonnull String event, @Nullable Object... arguments);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a set of peripherals that this computer access can "see", along with their attachment name.
 | 
			
		||||
@@ -170,45 +162,36 @@ public interface IComputerAccess
 | 
			
		||||
     * This may include other peripherals on the wired network or peripherals on other sides of the computer.
 | 
			
		||||
     *
 | 
			
		||||
     * @return All reachable peripherals
 | 
			
		||||
     * @throws NotAttachedException If the peripheral has been detached.
 | 
			
		||||
     * @see #getAttachmentName()
 | 
			
		||||
     * @see #getAvailablePeripheral(String)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default Map<String, IPeripheral> getAvailablePeripherals()
 | 
			
		||||
    {
 | 
			
		||||
        return Collections.emptyMap();
 | 
			
		||||
    }
 | 
			
		||||
    Map<String, IPeripheral> getAvailablePeripherals();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a reachable peripheral with the given attachment name. This is a equivalent to
 | 
			
		||||
     * {@link #getAvailablePeripherals()}{@code .get(name)}, though may be more efficient.
 | 
			
		||||
     * Get a reachable peripheral with the given attachment name. This is a equivalent to {@link #getAvailablePeripherals()}{@code .get(name)}, though may
 | 
			
		||||
     * be more efficient.
 | 
			
		||||
     *
 | 
			
		||||
     * @param name The peripheral's attached name
 | 
			
		||||
     * @return The reachable peripheral, or {@code null} if none can be found.
 | 
			
		||||
     * @see #getAvailablePeripherals()
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    default IPeripheral getAvailablePeripheral( @Nonnull String name )
 | 
			
		||||
    {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
    IPeripheral getAvailablePeripheral(@Nonnull String name);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a {@link IWorkMonitor} for tasks your peripheral might execute on the main (server) thread.
 | 
			
		||||
     *
 | 
			
		||||
     * This should be used to ensure your peripheral integrates with ComputerCraft's monitoring and limiting of how much
 | 
			
		||||
     * server time each computer consumes. You should not need to use this if you use
 | 
			
		||||
     * {@link ILuaContext#issueMainThreadTask(ILuaTask)} - this is intended for mods with their own system for running
 | 
			
		||||
     * work on the main thread.
 | 
			
		||||
     * This should be used to ensure your peripheral integrates with ComputerCraft's monitoring and limiting of how much server time each computer consumes.
 | 
			
		||||
     * You should not need to use this if you use {@link ILuaContext#issueMainThreadTask(ILuaTask)} - this is intended for mods with their own system for
 | 
			
		||||
     * running work on the main thread.
 | 
			
		||||
     *
 | 
			
		||||
     * Please note that the returned implementation is <em>not</em> thread-safe, and should only be used from the main
 | 
			
		||||
     * thread.
 | 
			
		||||
     * Please note that the returned implementation is <em>not</em> thread-safe, and should only be used from the main thread.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The work monitor for the main thread, or {@code null} if this computer does not have one.
 | 
			
		||||
     * @throws NotAttachedException If the peripheral has been detached.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    default IWorkMonitor getMainThreadMonitor()
 | 
			
		||||
    {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    IWorkMonitor getMainThreadMonitor();
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,53 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.lua.IArguments;
 | 
			
		||||
import dan200.computercraft.api.lua.IDynamicLuaObject;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaContext;
 | 
			
		||||
import dan200.computercraft.api.lua.LuaException;
 | 
			
		||||
import dan200.computercraft.api.lua.LuaFunction;
 | 
			
		||||
import dan200.computercraft.api.lua.MethodResult;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A peripheral whose methods are not known at runtime.
 | 
			
		||||
 *
 | 
			
		||||
 * This behaves similarly to {@link IDynamicLuaObject}, though also accepting the current {@link IComputerAccess}. Generally one may use {@link LuaFunction}
 | 
			
		||||
 * instead of implementing this interface.
 | 
			
		||||
 */
 | 
			
		||||
public interface IDynamicPeripheral extends IPeripheral {
 | 
			
		||||
    /**
 | 
			
		||||
     * Should return an array of strings that identify the methods that this peripheral exposes to Lua. This will be called once before each attachment, and
 | 
			
		||||
     * should not change when called multiple times.
 | 
			
		||||
     *
 | 
			
		||||
     * @return An array of strings representing method names.
 | 
			
		||||
     * @see #callMethod
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    String[] getMethodNames();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * This is called when a lua program on an attached computer calls {@code peripheral.call()} with one of the methods exposed by {@link
 | 
			
		||||
     * #getMethodNames()}.
 | 
			
		||||
     *
 | 
			
		||||
     * Be aware that this will be called from the ComputerCraft Lua thread, and must be thread-safe when interacting with Minecraft objects.
 | 
			
		||||
     *
 | 
			
		||||
     * @param computer The interface to the computer that is making the call. Remember that multiple computers can be attached to a peripheral at once.
 | 
			
		||||
     * @param context The context of the currently running lua thread. This can be used to wait for events or otherwise yield.
 | 
			
		||||
     * @param method An integer identifying which of the methods from getMethodNames() the computercraft wishes to call. The integer indicates the index
 | 
			
		||||
     *     into the getMethodNames() table that corresponds to the string passed into peripheral.call()
 | 
			
		||||
     * @param arguments The arguments for this method.
 | 
			
		||||
     * @return A {@link MethodResult} containing the values to return or the action to perform.
 | 
			
		||||
     * @throws LuaException If you throw any exception from this function, a lua error will be raised with the same message as your exception. Use this
 | 
			
		||||
     *     to throw appropriate errors if the wrong arguments are supplied to your method.
 | 
			
		||||
     * @see #getMethodNames()
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    MethodResult callMethod(@Nonnull IComputerAccess computer, @Nonnull ILuaContext context, int method, @Nonnull IArguments arguments) throws LuaException;
 | 
			
		||||
}
 | 
			
		||||
@@ -3,143 +3,82 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.lua.ArgumentHelper;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaContext;
 | 
			
		||||
import dan200.computercraft.api.lua.LuaException;
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.lua.LuaFunction;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The interface that defines a peripheral. See {@link IPeripheralProvider} for how to associate blocks with peripherals.
 | 
			
		||||
 * The interface that defines a peripheral.
 | 
			
		||||
 *
 | 
			
		||||
 * In order to expose a peripheral for your block or tile entity, you register a {@link IPeripheralProvider}. This <em>cannot</em> be implemented {@link
 | 
			
		||||
 * IPeripheral} directly on the tile.
 | 
			
		||||
 *
 | 
			
		||||
 * Peripherals should provide a series of methods to the user, either using {@link LuaFunction} or by implementing {@link IDynamicPeripheral}.
 | 
			
		||||
 */
 | 
			
		||||
public interface IPeripheral
 | 
			
		||||
{
 | 
			
		||||
public interface IPeripheral {
 | 
			
		||||
    /**
 | 
			
		||||
     * Should return a string that uniquely identifies this type of peripheral.
 | 
			
		||||
     * This can be queried from lua by calling {@code peripheral.getType()}
 | 
			
		||||
     * Should return a string that uniquely identifies this type of peripheral. This can be queried from lua by calling {@code peripheral.getType()}
 | 
			
		||||
     *
 | 
			
		||||
     * @return A string identifying the type of peripheral.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    String getType();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Should return an array of strings that identify the methods that this
 | 
			
		||||
     * peripheral exposes to Lua. This will be called once before each attachment,
 | 
			
		||||
     * and should not change when called multiple times.
 | 
			
		||||
     *
 | 
			
		||||
     * @return An array of strings representing method names.
 | 
			
		||||
     * @see #callMethod
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    String[] getMethodNames();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * This is called when a lua program on an attached computer calls {@code peripheral.call()} with
 | 
			
		||||
     * one of the methods exposed by {@link #getMethodNames()}.
 | 
			
		||||
     *
 | 
			
		||||
     * Be aware that this will be called from the ComputerCraft Lua thread, and must be thread-safe when interacting
 | 
			
		||||
     * with Minecraft objects.
 | 
			
		||||
     *
 | 
			
		||||
     * @param computer  The interface to the computer that is making the call. Remember that multiple
 | 
			
		||||
     *                  computers can be attached to a peripheral at once.
 | 
			
		||||
     * @param context   The context of the currently running lua thread. This can be used to wait for events
 | 
			
		||||
     *                  or otherwise yield.
 | 
			
		||||
     * @param method    An integer identifying which of the methods from getMethodNames() the computercraft
 | 
			
		||||
     *                  wishes to call. The integer indicates the index into the getMethodNames() table
 | 
			
		||||
     *                  that corresponds to the string passed into peripheral.call()
 | 
			
		||||
     * @param arguments An array of objects, representing the arguments passed into {@code peripheral.call()}.<br>
 | 
			
		||||
     *                  Lua values of type "string" will be represented by Object type String.<br>
 | 
			
		||||
     *                  Lua values of type "number" will be represented by Object type Double.<br>
 | 
			
		||||
     *                  Lua values of type "boolean" will be represented by Object type Boolean.<br>
 | 
			
		||||
     *                  Lua values of type "table" will be represented by Object type Map.<br>
 | 
			
		||||
     *                  Lua values of any other type will be represented by a null object.<br>
 | 
			
		||||
     *                  This array will be empty if no arguments are passed.
 | 
			
		||||
     *
 | 
			
		||||
     *                  It is recommended you use {@link ArgumentHelper} in order to validate and process arguments.
 | 
			
		||||
     * @return An array of objects, representing values you wish to return to the lua program. Integers, Doubles, Floats,
 | 
			
		||||
     * Strings, Booleans, Maps, ILuaObject and null be converted to their corresponding lua type. All other types will
 | 
			
		||||
     * be converted to nil.
 | 
			
		||||
     *
 | 
			
		||||
     * You may return null to indicate no values should be returned.
 | 
			
		||||
     * @throws LuaException         If you throw any exception from this function, a lua error will be raised with the
 | 
			
		||||
     *                              same message as your exception. Use this to throw appropriate errors if the wrong
 | 
			
		||||
     *                              arguments are supplied to your method.
 | 
			
		||||
     * @throws InterruptedException If the user shuts down or reboots the computer the coroutine is suspended,
 | 
			
		||||
     *                              InterruptedException will be thrown. This exception must not be caught or
 | 
			
		||||
     *                              intercepted, or the computer will leak memory and end up in a broken state.
 | 
			
		||||
     * @see #getMethodNames
 | 
			
		||||
     * @see ArgumentHelper
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    Object[] callMethod( @Nonnull IComputerAccess computer, @Nonnull ILuaContext context, int method, @Nonnull Object[] arguments ) throws LuaException, InterruptedException;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Is called when when a computer is attaching to the peripheral.
 | 
			
		||||
     *
 | 
			
		||||
     * This will occur when a peripheral is placed next to an active computer, when a computer is turned on next to a
 | 
			
		||||
     * peripheral, when a turtle travels into a square next to a peripheral, or when a wired modem adjacent to this
 | 
			
		||||
     * peripheral is does any of the above.
 | 
			
		||||
     * This will occur when a peripheral is placed next to an active computer, when a computer is turned on next to a peripheral, when a turtle travels into
 | 
			
		||||
     * a square next to a peripheral, or when a wired modem adjacent to this peripheral is does any of the above.
 | 
			
		||||
     *
 | 
			
		||||
     * Between calls to attach and {@link #detach}, the attached computer can make method calls on the peripheral using
 | 
			
		||||
     * {@code peripheral.call()}. This method can be used to keep track of which computers are attached to the
 | 
			
		||||
     * peripheral, or to take action when attachment occurs.
 | 
			
		||||
     * Between calls to attach and {@link #detach}, the attached computer can make method calls on the peripheral using {@code peripheral.call()}. This
 | 
			
		||||
     * method can be used to keep track of which computers are attached to the peripheral, or to take action when attachment occurs.
 | 
			
		||||
     *
 | 
			
		||||
     * Be aware that will be called from both the server thread and ComputerCraft Lua thread, and so must be thread-safe
 | 
			
		||||
     * and reentrant.
 | 
			
		||||
     * Be aware that will be called from both the server thread and ComputerCraft Lua thread, and so must be thread-safe and reentrant.
 | 
			
		||||
     *
 | 
			
		||||
     * @param computer The interface to the computer that is being attached. Remember that multiple computers can be
 | 
			
		||||
     *                 attached to a peripheral at once.
 | 
			
		||||
     * @param computer The interface to the computer that is being attached. Remember that multiple computers can be attached to a peripheral at once.
 | 
			
		||||
     * @see #detach
 | 
			
		||||
     */
 | 
			
		||||
    default void attach( @Nonnull IComputerAccess computer )
 | 
			
		||||
    {
 | 
			
		||||
    default void attach(@Nonnull IComputerAccess computer) {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Called when a computer is detaching from the peripheral.
 | 
			
		||||
     *
 | 
			
		||||
     * This will occur when a computer shuts down, when the peripheral is removed while attached to computers, when a
 | 
			
		||||
     * turtle moves away from a block attached to a peripheral, or when a wired modem adjacent to this peripheral is
 | 
			
		||||
     * detached.
 | 
			
		||||
     * This will occur when a computer shuts down, when the peripheral is removed while attached to computers, when a turtle moves away from a block
 | 
			
		||||
     * attached to a peripheral, or when a wired modem adjacent to this peripheral is detached.
 | 
			
		||||
     *
 | 
			
		||||
     * This method can be used to keep track of which computers are attached to the peripheral, or to take action when
 | 
			
		||||
     * detachment occurs.
 | 
			
		||||
     * This method can be used to keep track of which computers are attached to the peripheral, or to take action when detachment occurs.
 | 
			
		||||
     *
 | 
			
		||||
     * Be aware that this will be called from both the server and ComputerCraft Lua thread, and must be thread-safe
 | 
			
		||||
     * and reentrant.
 | 
			
		||||
     * Be aware that this will be called from both the server and ComputerCraft Lua thread, and must be thread-safe and reentrant.
 | 
			
		||||
     *
 | 
			
		||||
     * @param computer The interface to the computer that is being detached. Remember that multiple computers can be
 | 
			
		||||
     *                 attached to a peripheral at once.
 | 
			
		||||
     * @param computer The interface to the computer that is being detached. Remember that multiple computers can be attached to a peripheral at once.
 | 
			
		||||
     * @see #attach
 | 
			
		||||
     */
 | 
			
		||||
    default void detach( @Nonnull IComputerAccess computer )
 | 
			
		||||
    {
 | 
			
		||||
    default void detach(@Nonnull IComputerAccess computer) {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the object that this peripheral provides methods for. This will generally be the tile entity
 | 
			
		||||
     * or block, but may be an inventory, entity, etc...
 | 
			
		||||
     * Get the object that this peripheral provides methods for. This will generally be the tile entity or block, but may be an inventory, entity, etc...
 | 
			
		||||
     *
 | 
			
		||||
     * @return The object this peripheral targets
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default Object getTarget()
 | 
			
		||||
    {
 | 
			
		||||
        return this;
 | 
			
		||||
    @Nullable
 | 
			
		||||
    default Object getTarget() {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Determine whether this peripheral is equivalent to another one.
 | 
			
		||||
     *
 | 
			
		||||
     * The minimal example should at least check whether they are the same object. However, you may wish to check if
 | 
			
		||||
     * they point to the same block or tile entity.
 | 
			
		||||
     * The minimal example should at least check whether they are the same object. However, you may wish to check if they point to the same block or tile
 | 
			
		||||
     * entity.
 | 
			
		||||
     *
 | 
			
		||||
     * @param other The peripheral to compare against. This may be {@code null}.
 | 
			
		||||
     * @return Whether these peripherals are equivalent.
 | 
			
		||||
     */
 | 
			
		||||
    boolean equals( @Nullable IPeripheral other );
 | 
			
		||||
    boolean equals(@Nullable IPeripheral other);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,35 +3,36 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.tileentity.TileEntity;
 | 
			
		||||
import net.minecraft.util.EnumFacing;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
import java.util.Optional;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.block.entity.BlockEntity;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.util.math.Direction;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * This interface is used to create peripheral implementations for blocks.
 | 
			
		||||
 *
 | 
			
		||||
 * If you have a {@link TileEntity} which acts as a peripheral, you may alternatively implement {@link IPeripheralTile}.
 | 
			
		||||
 * If you have a {@link BlockEntity} which acts as a peripheral, you may alternatively expose the {@link IPeripheral} capability.
 | 
			
		||||
 *
 | 
			
		||||
 * @see dan200.computercraft.api.ComputerCraftAPI#registerPeripheralProvider(IPeripheralProvider)
 | 
			
		||||
 */
 | 
			
		||||
@FunctionalInterface
 | 
			
		||||
public interface IPeripheralProvider
 | 
			
		||||
{
 | 
			
		||||
public interface IPeripheralProvider {
 | 
			
		||||
    /**
 | 
			
		||||
     * Produce an peripheral implementation from a block location.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world The world the block is in.
 | 
			
		||||
     * @param pos   The position the block is at.
 | 
			
		||||
     * @param side  The side to get the peripheral from.
 | 
			
		||||
     * @return A peripheral, or {@code null} if there is not a peripheral here you'd like to handle.
 | 
			
		||||
     * @param pos The position the block is at.
 | 
			
		||||
     * @param side The side to get the peripheral from.
 | 
			
		||||
     * @return A peripheral, or {@link Optional#empty()} if there is not a peripheral here you'd like to handle.
 | 
			
		||||
     * @see dan200.computercraft.api.ComputerCraftAPI#registerPeripheralProvider(IPeripheralProvider)
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    IPeripheral getPeripheral( @Nonnull World world, @Nonnull BlockPos pos, @Nonnull EnumFacing side );
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    IPeripheral getPeripheral(@Nonnull World world, @Nonnull BlockPos pos, @Nonnull Direction side);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,32 +1,31 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2019. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.util.EnumFacing;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.util.math.Direction;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A {@link net.minecraft.tileentity.TileEntity} which may act as a peripheral.
 | 
			
		||||
 * A {@link net.minecraft.block.entity.BlockEntity} which may act as a peripheral.
 | 
			
		||||
 *
 | 
			
		||||
 * If you need more complex capabilities (such as handling TEs not belonging to your mod), you should use
 | 
			
		||||
 * {@link IPeripheralProvider}.
 | 
			
		||||
 * If you need more complex capabilities (such as handling TEs not belonging to your mod), you should use {@link IPeripheralProvider}.
 | 
			
		||||
 */
 | 
			
		||||
public interface IPeripheralTile
 | 
			
		||||
{
 | 
			
		||||
public interface IPeripheralTile {
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the peripheral on the given {@code side}.
 | 
			
		||||
     *
 | 
			
		||||
     * @param side The side to get the peripheral from.
 | 
			
		||||
     * @return A peripheral, or {@code null} if there is not a peripheral here.
 | 
			
		||||
     * @see IPeripheralProvider#getPeripheral(World, BlockPos, EnumFacing)
 | 
			
		||||
     * @see IPeripheralProvider#getPeripheral(World, BlockPos, Direction)
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    IPeripheral getPeripheral( @Nonnull EnumFacing side );
 | 
			
		||||
    IPeripheral getPeripheral(@Nonnull Direction side);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,29 +3,61 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
import java.util.concurrent.TimeUnit;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Monitors "work" associated with a computer, keeping track of how much a computer has done, and ensuring every
 | 
			
		||||
 * computer receives a fair share of any processing time.
 | 
			
		||||
 * Monitors "work" associated with a computer, keeping track of how much a computer has done, and ensuring every computer receives a fair share of any
 | 
			
		||||
 * processing time.
 | 
			
		||||
 *
 | 
			
		||||
 * This is primarily intended for work done by peripherals on the main thread (such as on a tile entity's tick), but
 | 
			
		||||
 * could be used for other purposes (such as complex computations done on another thread).
 | 
			
		||||
 * This is primarily intended for work done by peripherals on the main thread (such as on a tile entity's tick), but could be used for other purposes (such
 | 
			
		||||
 * as complex computations done on another thread).
 | 
			
		||||
 *
 | 
			
		||||
 * Before running a task, one should call {@link #canWork()} to determine if the computer is currently allowed to
 | 
			
		||||
 * execute work. If that returns true, you should execute the task and use {@link #trackWork(long, TimeUnit)} to inform
 | 
			
		||||
 * the monitor how long that task took.
 | 
			
		||||
 * Before running a task, one should call {@link #canWork()} to determine if the computer is currently allowed to execute work. If that returns true, you
 | 
			
		||||
 * should execute the task and use {@link #trackWork(long, TimeUnit)} to inform the monitor how long that task took.
 | 
			
		||||
 *
 | 
			
		||||
 * Alternatively, use {@link #runWork(Runnable)} to run and keep track of work.
 | 
			
		||||
 *
 | 
			
		||||
 * @see IComputerAccess#getMainThreadMonitor()
 | 
			
		||||
 */
 | 
			
		||||
public interface IWorkMonitor
 | 
			
		||||
{
 | 
			
		||||
public interface IWorkMonitor {
 | 
			
		||||
    /**
 | 
			
		||||
     * If the owning computer is currently allowed to execute work, and has ample time to do so.
 | 
			
		||||
     *
 | 
			
		||||
     * This is effectively a more restrictive form of {@link #canWork()}. One should use that in order to determine if you may do an initial piece of work,
 | 
			
		||||
     * and shouldWork to determine if any additional task may be performed.
 | 
			
		||||
     *
 | 
			
		||||
     * @return If we should execute work right now.
 | 
			
		||||
     */
 | 
			
		||||
    boolean shouldWork();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Run a task if possible, and inform the monitor of how long it took.
 | 
			
		||||
     *
 | 
			
		||||
     * @param runnable The task to run.
 | 
			
		||||
     * @return If the task was actually run (namely, {@link #canWork()} returned {@code true}).
 | 
			
		||||
     */
 | 
			
		||||
    default boolean runWork(@Nonnull Runnable runnable) {
 | 
			
		||||
        Objects.requireNonNull(runnable, "runnable should not be null");
 | 
			
		||||
        if (!this.canWork()) {
 | 
			
		||||
            return false;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        long start = System.nanoTime();
 | 
			
		||||
        try {
 | 
			
		||||
            runnable.run();
 | 
			
		||||
        } finally {
 | 
			
		||||
            this.trackWork(System.nanoTime() - start, TimeUnit.NANOSECONDS);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return true;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * If the owning computer is currently allowed to execute work.
 | 
			
		||||
     *
 | 
			
		||||
@@ -33,45 +65,11 @@ public interface IWorkMonitor
 | 
			
		||||
     */
 | 
			
		||||
    boolean canWork();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * If the owning computer is currently allowed to execute work, and has ample time to do so.
 | 
			
		||||
     *
 | 
			
		||||
     * This is effectively a more restrictive form of {@link #canWork()}. One should use that in order to determine if
 | 
			
		||||
     * you may do an initial piece of work, and shouldWork to determine if any additional task may be performed.
 | 
			
		||||
     *
 | 
			
		||||
     * @return If we should execute work right now.
 | 
			
		||||
     */
 | 
			
		||||
    boolean shouldWork();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Inform the monitor how long some piece of work took to execute.
 | 
			
		||||
     *
 | 
			
		||||
     * @param time The time some task took to run
 | 
			
		||||
     * @param unit The unit that {@code time} was measured in.
 | 
			
		||||
     */
 | 
			
		||||
    void trackWork( long time, @Nonnull TimeUnit unit );
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Run a task if possible, and inform the monitor of how long it took.
 | 
			
		||||
     *
 | 
			
		||||
     * @param runnable The task to run.
 | 
			
		||||
     * @return If the task was actually run (namely, {@link #canWork()} returned {@code true}).
 | 
			
		||||
     */
 | 
			
		||||
    default boolean runWork( @Nonnull Runnable runnable )
 | 
			
		||||
    {
 | 
			
		||||
        Objects.requireNonNull( runnable, "runnable should not be null" );
 | 
			
		||||
        if( !canWork() ) return false;
 | 
			
		||||
 | 
			
		||||
        long start = System.nanoTime();
 | 
			
		||||
        try
 | 
			
		||||
        {
 | 
			
		||||
            runnable.run();
 | 
			
		||||
        }
 | 
			
		||||
        finally
 | 
			
		||||
        {
 | 
			
		||||
            trackWork( System.nanoTime() - start, TimeUnit.NANOSECONDS );
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return true;
 | 
			
		||||
    }
 | 
			
		||||
    void trackWork(long time, @Nonnull TimeUnit unit);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,22 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Thrown when performing operations on {@link IComputerAccess} when the current peripheral is no longer attached to the computer.
 | 
			
		||||
 */
 | 
			
		||||
public class NotAttachedException extends IllegalStateException {
 | 
			
		||||
    private static final long serialVersionUID = 1221244785535553536L;
 | 
			
		||||
 | 
			
		||||
    public NotAttachedException() {
 | 
			
		||||
        super("You are not attached to this computer");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public NotAttachedException(String s) {
 | 
			
		||||
        super(s);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
@API( owner = "ComputerCraft", provides = "ComputerCraft|API|Peripheral", apiVersion = "${version}" )
 | 
			
		||||
package dan200.computercraft.api.peripheral;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.API;
 | 
			
		||||
@@ -1,41 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.permissions;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * This interface is used to restrict where turtles can move or build.
 | 
			
		||||
 *
 | 
			
		||||
 * Turtles will call these methods before attempting to perform an action, allowing them to be cancelled.
 | 
			
		||||
 *
 | 
			
		||||
 * @see dan200.computercraft.api.ComputerCraftAPI#registerPermissionProvider(ITurtlePermissionProvider)
 | 
			
		||||
 */
 | 
			
		||||
public interface ITurtlePermissionProvider
 | 
			
		||||
{
 | 
			
		||||
    /**
 | 
			
		||||
     * Determine whether a block can be entered by a turtle.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world The world the block exists in
 | 
			
		||||
     * @param pos   The location of the block.
 | 
			
		||||
     * @return Whether the turtle can move into this block.
 | 
			
		||||
     */
 | 
			
		||||
    boolean isBlockEnterable( @Nonnull World world, @Nonnull BlockPos pos );
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Determine whether a block can be modified by a turtle.
 | 
			
		||||
     *
 | 
			
		||||
     * This includes breaking and placing blocks.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world The world the block exists in
 | 
			
		||||
     * @param pos   The location of the block.
 | 
			
		||||
     * @return Whether the turtle can modify this block.
 | 
			
		||||
     */
 | 
			
		||||
    boolean isBlockEditable( @Nonnull World world, @Nonnull BlockPos pos );
 | 
			
		||||
}
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
@API( owner = "ComputerCraft", provides = "ComputerCraft|API|Permissions", apiVersion = "${version}" )
 | 
			
		||||
package dan200.computercraft.api.permissions;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.API;
 | 
			
		||||
@@ -3,54 +3,58 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.pocket;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.ResourceLocation;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.item.ItemConvertible;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.Identifier;
 | 
			
		||||
import net.minecraft.util.Util;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A base class for {@link IPocketUpgrade}s.
 | 
			
		||||
 *
 | 
			
		||||
 * One does not have to use this, but it does provide a convenient template.
 | 
			
		||||
 */
 | 
			
		||||
public abstract class AbstractPocketUpgrade implements IPocketUpgrade
 | 
			
		||||
{
 | 
			
		||||
    private final ResourceLocation id;
 | 
			
		||||
public abstract class AbstractPocketUpgrade implements IPocketUpgrade {
 | 
			
		||||
    private final Identifier id;
 | 
			
		||||
    private final String adjective;
 | 
			
		||||
    private final ItemStack stack;
 | 
			
		||||
 | 
			
		||||
    protected AbstractPocketUpgrade( ResourceLocation id, String adjective, ItemStack stack )
 | 
			
		||||
    {
 | 
			
		||||
    protected AbstractPocketUpgrade(Identifier id, ItemConvertible item) {
 | 
			
		||||
        this(id, Util.createTranslationKey("upgrade", id) + ".adjective", item);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractPocketUpgrade(Identifier id, String adjective, ItemConvertible item) {
 | 
			
		||||
        this.id = id;
 | 
			
		||||
        this.adjective = adjective;
 | 
			
		||||
        this.stack = new ItemStack(item);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractPocketUpgrade(Identifier id, String adjective, ItemStack stack) {
 | 
			
		||||
        this.id = id;
 | 
			
		||||
        this.adjective = adjective;
 | 
			
		||||
        this.stack = stack;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractPocketUpgrade( ResourceLocation id, ItemStack stack )
 | 
			
		||||
    {
 | 
			
		||||
        this( id, "upgrade." + id + ".adjective", stack );
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final Identifier getUpgradeID() {
 | 
			
		||||
        return this.id;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final ResourceLocation getUpgradeID()
 | 
			
		||||
    {
 | 
			
		||||
        return id;
 | 
			
		||||
    public final String getUnlocalisedAdjective() {
 | 
			
		||||
        return this.adjective;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final String getUnlocalisedAdjective()
 | 
			
		||||
    {
 | 
			
		||||
        return adjective;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final ItemStack getCraftingItem()
 | 
			
		||||
    {
 | 
			
		||||
        return stack;
 | 
			
		||||
    public final ItemStack getCraftingItem() {
 | 
			
		||||
        return this.stack;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,47 +3,38 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.pocket;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import net.minecraft.entity.Entity;
 | 
			
		||||
import net.minecraft.nbt.NBTTagCompound;
 | 
			
		||||
import net.minecraft.util.ResourceLocation;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.entity.Entity;
 | 
			
		||||
import net.minecraft.nbt.CompoundTag;
 | 
			
		||||
import net.minecraft.util.Identifier;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Wrapper class for pocket computers.
 | 
			
		||||
 */
 | 
			
		||||
public interface IPocketAccess
 | 
			
		||||
{
 | 
			
		||||
public interface IPocketAccess {
 | 
			
		||||
    /**
 | 
			
		||||
     * Gets the entity holding this item.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The holding entity. This may be {@code null}.
 | 
			
		||||
     * @deprecated Use {@link #getValidEntity()} where possible.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    @Deprecated
 | 
			
		||||
    Entity getEntity();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Gets the entity holding this item with additional safety checks.
 | 
			
		||||
     *
 | 
			
		||||
     * This must be called on the server thread.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The holding entity, or {@code null} if none exists.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    Entity getValidEntity();
 | 
			
		||||
    Entity getEntity();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the colour of this pocket computer as a RGB number.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The colour this pocket computer is. This will be a RGB colour between {@code 0x000000} and
 | 
			
		||||
     * {@code 0xFFFFFF} or -1 if it has no colour.
 | 
			
		||||
     * @return The colour this pocket computer is. This will be a RGB colour between {@code 0x000000} and {@code 0xFFFFFF} or -1 if it has no colour.
 | 
			
		||||
     * @see #setColour(int)
 | 
			
		||||
     */
 | 
			
		||||
    int getColour();
 | 
			
		||||
@@ -51,17 +42,16 @@ public interface IPocketAccess
 | 
			
		||||
    /**
 | 
			
		||||
     * Set the colour of the pocket computer to a RGB number.
 | 
			
		||||
     *
 | 
			
		||||
     * @param colour The colour this pocket computer should be changed to. This should be a RGB colour between
 | 
			
		||||
     *               {@code 0x000000} and {@code 0xFFFFFF} or -1 to reset to the default colour.
 | 
			
		||||
     * @param colour The colour this pocket computer should be changed to. This should be a RGB colour between {@code 0x000000} and {@code 0xFFFFFF} or
 | 
			
		||||
     *     -1 to reset to the default colour.
 | 
			
		||||
     * @see #getColour()
 | 
			
		||||
     */
 | 
			
		||||
    void setColour( int colour );
 | 
			
		||||
    void setColour(int colour);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the colour of this pocket computer's light as a RGB number.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The colour this light is. This will be a RGB colour between {@code 0x000000} and {@code 0xFFFFFF} or
 | 
			
		||||
     * -1 if it has no colour.
 | 
			
		||||
     * @return The colour this light is. This will be a RGB colour between {@code 0x000000} and {@code 0xFFFFFF} or -1 if it has no colour.
 | 
			
		||||
     * @see #setLight(int)
 | 
			
		||||
     */
 | 
			
		||||
    int getLight();
 | 
			
		||||
@@ -69,11 +59,11 @@ public interface IPocketAccess
 | 
			
		||||
    /**
 | 
			
		||||
     * Set the colour of the pocket computer's light to a RGB number.
 | 
			
		||||
     *
 | 
			
		||||
     * @param colour The colour this modem's light will be changed to. This should be a RGB colour between
 | 
			
		||||
     *               {@code 0x000000} and {@code 0xFFFFFF} or -1 to reset to the default colour.
 | 
			
		||||
     * @param colour The colour this modem's light will be changed to. This should be a RGB colour between {@code 0x000000} and {@code 0xFFFFFF} or -1
 | 
			
		||||
     *     to reset to the default colour.
 | 
			
		||||
     * @see #getLight()
 | 
			
		||||
     */
 | 
			
		||||
    void setLight( int colour );
 | 
			
		||||
    void setLight(int colour);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the upgrade-specific NBT.
 | 
			
		||||
@@ -84,7 +74,7 @@ public interface IPocketAccess
 | 
			
		||||
     * @see #updateUpgradeNBTData()
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    NBTTagCompound getUpgradeNBTData();
 | 
			
		||||
    CompoundTag getUpgradeNBTData();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Mark the upgrade-specific NBT as dirty.
 | 
			
		||||
@@ -104,5 +94,5 @@ public interface IPocketAccess
 | 
			
		||||
     * @return A collection of all upgrade names.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    Map<ResourceLocation, IPeripheral> getUpgrades();
 | 
			
		||||
    Map<Identifier, IPeripheral> getUpgrades();
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,39 +3,39 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.pocket;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import dan200.computercraft.api.turtle.ITurtleUpgrade;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.ResourceLocation;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.Identifier;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Additional peripherals for pocket computers.
 | 
			
		||||
 *
 | 
			
		||||
 * This is similar to {@link ITurtleUpgrade}.
 | 
			
		||||
 */
 | 
			
		||||
public interface IPocketUpgrade
 | 
			
		||||
{
 | 
			
		||||
public interface IPocketUpgrade {
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Gets a unique identifier representing this type of turtle upgrade. eg: "computercraft:wireless_modem" or
 | 
			
		||||
     * "my_mod:my_upgrade".
 | 
			
		||||
     * Gets a unique identifier representing this type of turtle upgrade. eg: "computercraft:wireless_modem" or "my_mod:my_upgrade".
 | 
			
		||||
     *
 | 
			
		||||
     * You should use a unique resource domain to ensure this upgrade is uniquely identified. The upgrade will fail
 | 
			
		||||
     * registration if an already used ID is specified.
 | 
			
		||||
     * You should use a unique resource domain to ensure this upgrade is uniquely identified. The upgrade will fail registration if an already used ID is
 | 
			
		||||
     * specified.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The upgrade's id.
 | 
			
		||||
     * @see IPocketUpgrade#getUpgradeID()
 | 
			
		||||
     * @see ComputerCraftAPI#registerPocketUpgrade(IPocketUpgrade)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    ResourceLocation getUpgradeID();
 | 
			
		||||
    Identifier getUpgradeID();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Return an unlocalised string to describe the type of pocket computer this upgrade provides.
 | 
			
		||||
@@ -49,12 +49,11 @@ public interface IPocketUpgrade
 | 
			
		||||
    String getUnlocalisedAdjective();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Return an item stack representing the type of item that a pocket computer must be crafted with to create a
 | 
			
		||||
     * pocket computer which holds this upgrade. This item stack is also used to determine the upgrade given by
 | 
			
		||||
     * {@code pocket.equip()}/{@code pocket.unequip()}.
 | 
			
		||||
     * Return an item stack representing the type of item that a pocket computer must be crafted with to create a pocket computer which holds this upgrade.
 | 
			
		||||
     * This item stack is also used to determine the upgrade given by {@code pocket.equip()}/{@code pocket.unequip()}.
 | 
			
		||||
     *
 | 
			
		||||
     * Ideally this should be constant over a session. It is recommended that you cache
 | 
			
		||||
     * the item too, in order to prevent constructing it every time the method is called.
 | 
			
		||||
     * Ideally this should be constant over a session. It is recommended that you cache the item too, in order to prevent constructing it every time the
 | 
			
		||||
     * method is called.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The item stack used for crafting. This can be {@link ItemStack#EMPTY} if crafting is disabled.
 | 
			
		||||
     */
 | 
			
		||||
@@ -64,41 +63,37 @@ public interface IPocketUpgrade
 | 
			
		||||
    /**
 | 
			
		||||
     * Creates a peripheral for the pocket computer.
 | 
			
		||||
     *
 | 
			
		||||
     * The peripheral created will be stored for the lifetime of the upgrade, will be passed an argument to
 | 
			
		||||
     * {@link #update(IPocketAccess, IPeripheral)} and will be attached, detached and have methods called in the same
 | 
			
		||||
     * manner as an ordinary peripheral.
 | 
			
		||||
     * The peripheral created will be stored for the lifetime of the upgrade, will be passed an argument to {@link #update(IPocketAccess, IPeripheral)} and
 | 
			
		||||
     * will be attached, detached and have methods called in the same manner as an ordinary peripheral.
 | 
			
		||||
     *
 | 
			
		||||
     * @param access The access object for the pocket item stack.
 | 
			
		||||
     * @return The newly created peripheral.
 | 
			
		||||
     * @see #update(IPocketAccess, IPeripheral)
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    IPeripheral createPeripheral( @Nonnull IPocketAccess access );
 | 
			
		||||
    IPeripheral createPeripheral(@Nonnull IPocketAccess access);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Called when the pocket computer item stack updates.
 | 
			
		||||
     *
 | 
			
		||||
     * @param access     The access object for the pocket item stack.
 | 
			
		||||
     * @param access The access object for the pocket item stack.
 | 
			
		||||
     * @param peripheral The peripheral for this upgrade.
 | 
			
		||||
     * @see #createPeripheral(IPocketAccess)
 | 
			
		||||
     */
 | 
			
		||||
    default void update( @Nonnull IPocketAccess access, @Nullable IPeripheral peripheral )
 | 
			
		||||
    {
 | 
			
		||||
    default void update(@Nonnull IPocketAccess access, @Nullable IPeripheral peripheral) {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Called when the pocket computer is right clicked.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world      The world the computer is in.
 | 
			
		||||
     * @param access     The access object for the pocket item stack.
 | 
			
		||||
     * @param world The world the computer is in.
 | 
			
		||||
     * @param access The access object for the pocket item stack.
 | 
			
		||||
     * @param peripheral The peripheral for this upgrade.
 | 
			
		||||
     * @return {@code true} to stop the GUI from opening, otherwise false. You should always provide some code path
 | 
			
		||||
     * which returns {@code false}, such as requiring the player to be sneaking - otherwise they will be unable to
 | 
			
		||||
     * access the GUI.
 | 
			
		||||
     * @return {@code true} to stop the GUI from opening, otherwise false. You should always provide some code path which returns {@code false}, such as
 | 
			
		||||
     *     requiring the player to be sneaking - otherwise they will be unable to access the GUI.
 | 
			
		||||
     * @see #createPeripheral(IPocketAccess)
 | 
			
		||||
     */
 | 
			
		||||
    default boolean onRightClick( @Nonnull World world, @Nonnull IPocketAccess access, @Nullable IPeripheral peripheral )
 | 
			
		||||
    {
 | 
			
		||||
    default boolean onRightClick(@Nonnull World world, @Nonnull IPocketAccess access, @Nullable IPeripheral peripheral) {
 | 
			
		||||
        return false;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,31 +3,30 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.redstone;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.util.EnumFacing;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.util.math.Direction;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * This interface is used to provide bundled redstone output for blocks.
 | 
			
		||||
 *
 | 
			
		||||
 * @see dan200.computercraft.api.ComputerCraftAPI#registerBundledRedstoneProvider(IBundledRedstoneProvider)
 | 
			
		||||
 */
 | 
			
		||||
@FunctionalInterface
 | 
			
		||||
public interface IBundledRedstoneProvider
 | 
			
		||||
{
 | 
			
		||||
public interface IBundledRedstoneProvider {
 | 
			
		||||
    /**
 | 
			
		||||
     * Produce an bundled redstone output from a block location.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world The world this block is in.
 | 
			
		||||
     * @param pos   The position this block is at.
 | 
			
		||||
     * @param side  The side to extract the bundled redstone output from.
 | 
			
		||||
     * @return A number in the range 0-65535 to indicate this block is providing output, or -1 if you do not wish to
 | 
			
		||||
     * handle this block.
 | 
			
		||||
     * @param pos The position this block is at.
 | 
			
		||||
     * @param side The side to extract the bundled redstone output from.
 | 
			
		||||
     * @return A number in the range 0-65535 to indicate this block is providing output, or -1 if you do not wish to handle this block.
 | 
			
		||||
     * @see dan200.computercraft.api.ComputerCraftAPI#registerBundledRedstoneProvider(IBundledRedstoneProvider)
 | 
			
		||||
     */
 | 
			
		||||
    int getBundledRedstoneOutput( @Nonnull World world, @Nonnull BlockPos pos, @Nonnull EnumFacing side );
 | 
			
		||||
    int getBundledRedstoneOutput(@Nonnull World world, @Nonnull BlockPos pos, @Nonnull Direction side);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
@API( owner = "ComputerCraft", provides = "ComputerCraft|API|Redstone", apiVersion = "${version}" )
 | 
			
		||||
package dan200.computercraft.api.redstone;
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.fml.common.API;
 | 
			
		||||
@@ -0,0 +1,70 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of the public ComputerCraft API - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.item.ItemConvertible;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.Identifier;
 | 
			
		||||
import net.minecraft.util.Util;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A base class for {@link ITurtleUpgrade}s.
 | 
			
		||||
 *
 | 
			
		||||
 * One does not have to use this, but it does provide a convenient template.
 | 
			
		||||
 */
 | 
			
		||||
public abstract class AbstractTurtleUpgrade implements ITurtleUpgrade {
 | 
			
		||||
    private final Identifier id;
 | 
			
		||||
    private final TurtleUpgradeType type;
 | 
			
		||||
    private final String adjective;
 | 
			
		||||
    private final ItemStack stack;
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade(Identifier id, TurtleUpgradeType type, String adjective, ItemConvertible item) {
 | 
			
		||||
        this(id, type, adjective, new ItemStack(item));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade(Identifier id, TurtleUpgradeType type, String adjective, ItemStack stack) {
 | 
			
		||||
        this.id = id;
 | 
			
		||||
        this.type = type;
 | 
			
		||||
        this.adjective = adjective;
 | 
			
		||||
        this.stack = stack;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade(Identifier id, TurtleUpgradeType type, ItemConvertible item) {
 | 
			
		||||
        this(id, type, new ItemStack(item));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    protected AbstractTurtleUpgrade(Identifier id, TurtleUpgradeType type, ItemStack stack) {
 | 
			
		||||
        this(id, type, Util.createTranslationKey("upgrade", id) + ".adjective", stack);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final Identifier getUpgradeID() {
 | 
			
		||||
        return this.id;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final String getUnlocalisedAdjective() {
 | 
			
		||||
        return this.adjective;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final TurtleUpgradeType getType() {
 | 
			
		||||
        return this.type;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Override
 | 
			
		||||
    public final ItemStack getCraftingItem() {
 | 
			
		||||
        return this.stack;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										266
									
								
								src/main/java/dan200/computercraft/api/turtle/FakePlayer.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										266
									
								
								src/main/java/dan200/computercraft/api/turtle/FakePlayer.java
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,266 @@
 | 
			
		||||
/*
 | 
			
		||||
 * This file is part of ComputerCraft - http://www.computercraft.info
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2018. Do not distribute without permission.
 | 
			
		||||
 * Send enquiries to dratcliffe@gmail.com
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import java.util.Collection;
 | 
			
		||||
import java.util.OptionalInt;
 | 
			
		||||
import java.util.UUID;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import javax.crypto.SecretKey;
 | 
			
		||||
 | 
			
		||||
import com.mojang.authlib.GameProfile;
 | 
			
		||||
import io.netty.channel.ChannelHandlerContext;
 | 
			
		||||
import io.netty.util.concurrent.Future;
 | 
			
		||||
import io.netty.util.concurrent.GenericFutureListener;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.block.entity.CommandBlockBlockEntity;
 | 
			
		||||
import net.minecraft.block.entity.SignBlockEntity;
 | 
			
		||||
import net.minecraft.command.argument.EntityAnchorArgumentType;
 | 
			
		||||
import net.minecraft.entity.Entity;
 | 
			
		||||
import net.minecraft.entity.damage.DamageSource;
 | 
			
		||||
import net.minecraft.entity.effect.StatusEffectInstance;
 | 
			
		||||
import net.minecraft.entity.passive.HorseBaseEntity;
 | 
			
		||||
import net.minecraft.inventory.Inventory;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.network.ClientConnection;
 | 
			
		||||
import net.minecraft.network.MessageType;
 | 
			
		||||
import net.minecraft.network.NetworkSide;
 | 
			
		||||
import net.minecraft.network.NetworkState;
 | 
			
		||||
import net.minecraft.network.Packet;
 | 
			
		||||
import net.minecraft.network.packet.c2s.play.RequestCommandCompletionsC2SPacket;
 | 
			
		||||
import net.minecraft.network.packet.c2s.play.VehicleMoveC2SPacket;
 | 
			
		||||
import net.minecraft.recipe.Recipe;
 | 
			
		||||
import net.minecraft.screen.NamedScreenHandlerFactory;
 | 
			
		||||
import net.minecraft.screen.ScreenHandler;
 | 
			
		||||
import net.minecraft.server.network.ServerPlayNetworkHandler;
 | 
			
		||||
import net.minecraft.server.network.ServerPlayerEntity;
 | 
			
		||||
import net.minecraft.server.network.ServerPlayerInteractionManager;
 | 
			
		||||
import net.minecraft.server.world.ServerWorld;
 | 
			
		||||
import net.minecraft.sound.SoundCategory;
 | 
			
		||||
import net.minecraft.sound.SoundEvent;
 | 
			
		||||
import net.minecraft.text.Text;
 | 
			
		||||
import net.minecraft.util.Hand;
 | 
			
		||||
import net.minecraft.util.collection.DefaultedList;
 | 
			
		||||
import net.minecraft.util.math.ChunkPos;
 | 
			
		||||
import net.minecraft.util.math.Vec3d;
 | 
			
		||||
import net.minecraft.village.TraderOfferList;
 | 
			
		||||
import net.minecraft.world.GameMode;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A wrapper for {@link ServerPlayerEntity} which denotes a "fake" player.
 | 
			
		||||
 *
 | 
			
		||||
 * Please note that this does not implement any of the traditional fake player behaviour. It simply exists to prevent me passing in normal players.
 | 
			
		||||
 */
 | 
			
		||||
public class FakePlayer extends ServerPlayerEntity {
 | 
			
		||||
    public FakePlayer(ServerWorld world, GameProfile gameProfile) {
 | 
			
		||||
        super(world.getServer(), world, gameProfile, new ServerPlayerInteractionManager(world));
 | 
			
		||||
        this.networkHandler = new FakeNetHandler(this);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // region Direct networkHandler access
 | 
			
		||||
    @Override
 | 
			
		||||
    public void enterCombat() { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void endCombat() { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void tick() { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void playerTick() { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void onDeath(DamageSource damage) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public Entity moveToWorld(ServerWorld destination) {
 | 
			
		||||
        return this;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void wakeUp(boolean bl, boolean updateSleepingPlayers) {
 | 
			
		||||
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public boolean startRiding(Entity entity, boolean flag) {
 | 
			
		||||
        return false;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void stopRiding() { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void openEditSignScreen(SignBlockEntity tile) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public OptionalInt openHandledScreen(@Nullable NamedScreenHandlerFactory container) {
 | 
			
		||||
        return OptionalInt.empty();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void sendTradeOffers(int id, TraderOfferList list, int level, int experience, boolean levelled, boolean refreshable) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void openHorseInventory(HorseBaseEntity horse, Inventory inventory) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void openEditBookScreen(ItemStack stack, Hand hand) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void openCommandBlockScreen(CommandBlockBlockEntity block) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void onSlotUpdate(ScreenHandler container, int slot, ItemStack stack) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void onHandlerRegistered(ScreenHandler container, DefaultedList<ItemStack> defaultedList) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void onPropertyUpdate(ScreenHandler container, int key, int value) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void closeHandledScreen() { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void updateCursorStack() { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public int unlockRecipes(Collection<Recipe<?>> recipes) {
 | 
			
		||||
        return 0;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Indirect
 | 
			
		||||
    @Override
 | 
			
		||||
    public int lockRecipes(Collection<Recipe<?>> recipes) {
 | 
			
		||||
        return 0;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void sendMessage(Text textComponent, boolean status) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    protected void consumeItem() { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void lookAt(EntityAnchorArgumentType.EntityAnchor anchor, Vec3d vec3d) {}
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void method_14222(EntityAnchorArgumentType.EntityAnchor self, Entity entity, EntityAnchorArgumentType.EntityAnchor target) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    protected void onStatusEffectApplied(StatusEffectInstance statusEffectInstance) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    protected void onStatusEffectUpgraded(StatusEffectInstance statusEffectInstance, boolean particles) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    protected void onStatusEffectRemoved(StatusEffectInstance statusEffectInstance) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void requestTeleport(double x, double y, double z) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void setGameMode(GameMode gameMode) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void sendMessage(Text message, MessageType type, UUID senderUuid) {
 | 
			
		||||
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public String getIp() {
 | 
			
		||||
        return "[Fake Player]";
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void sendResourcePackUrl(String url, String hash) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void onStoppedTracking(Entity entity) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void setCameraEntity(Entity entity) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void teleport(ServerWorld serverWorld, double x, double y, double z, float pitch, float yaw) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void sendInitialChunkPackets(ChunkPos chunkPos, Packet<?> packet, Packet<?> packet2) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void sendUnloadChunkPacket(ChunkPos chunkPos) { }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void playSound(SoundEvent soundEvent, SoundCategory soundCategory, float volume, float pitch) { }
 | 
			
		||||
 | 
			
		||||
    private static class FakeNetHandler extends ServerPlayNetworkHandler {
 | 
			
		||||
        FakeNetHandler(ServerPlayerEntity player) {
 | 
			
		||||
            super(player.server, new FakeConnection(), player);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void disconnect(Text message) { }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void onVehicleMove(VehicleMoveC2SPacket move) { }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void onRequestCommandCompletions(RequestCommandCompletionsC2SPacket packet) { }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void sendPacket(Packet<?> packet, @Nullable GenericFutureListener<? extends Future<? super Void>> listener) { }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static class FakeConnection extends ClientConnection {
 | 
			
		||||
        FakeConnection() {
 | 
			
		||||
            super(NetworkSide.CLIENTBOUND);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void channelActive(ChannelHandlerContext active) {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void setState(NetworkState state) {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void exceptionCaught(ChannelHandlerContext context, Throwable err) {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        protected void channelRead0(ChannelHandlerContext context, Packet<?> packet) {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void send(Packet<?> packet, @Nullable GenericFutureListener<? extends Future<? super Void>> listener) {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void tick() {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void disconnect(Text message) {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void setupEncryption(SecretKey key) {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void disableAutoRead() {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        @Override
 | 
			
		||||
        public void setCompressionThreshold(int size) {
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -3,31 +3,31 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import com.mojang.authlib.GameProfile;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaContext;
 | 
			
		||||
import dan200.computercraft.api.lua.LuaException;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import net.minecraft.inventory.IInventory;
 | 
			
		||||
import net.minecraft.nbt.NBTTagCompound;
 | 
			
		||||
import net.minecraft.util.EnumFacing;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.util.math.Vec3d;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
import net.minecraftforge.items.IItemHandlerModifiable;
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
 | 
			
		||||
import com.mojang.authlib.GameProfile;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaCallback;
 | 
			
		||||
import dan200.computercraft.api.lua.MethodResult;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import dan200.computercraft.shared.util.ItemStorage;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.inventory.Inventory;
 | 
			
		||||
import net.minecraft.nbt.CompoundTag;
 | 
			
		||||
import net.minecraft.util.math.BlockPos;
 | 
			
		||||
import net.minecraft.util.math.Direction;
 | 
			
		||||
import net.minecraft.util.math.Vec3d;
 | 
			
		||||
import net.minecraft.world.World;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The interface passed to turtle by turtles, providing methods that they can call.
 | 
			
		||||
 *
 | 
			
		||||
 * This should not be implemented by your classes. Do not interact with turtles except via this interface and
 | 
			
		||||
 * {@link ITurtleUpgrade}.
 | 
			
		||||
 * This should not be implemented by your classes. Do not interact with turtles except via this interface and {@link ITurtleUpgrade}.
 | 
			
		||||
 */
 | 
			
		||||
public interface ITurtleAccess
 | 
			
		||||
{
 | 
			
		||||
public interface ITurtleAccess {
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the world in which the turtle resides.
 | 
			
		||||
     *
 | 
			
		||||
@@ -47,28 +47,25 @@ public interface ITurtleAccess
 | 
			
		||||
    /**
 | 
			
		||||
     * Attempt to move this turtle to a new position.
 | 
			
		||||
     *
 | 
			
		||||
     * This will preserve the turtle's internal state, such as it's inventory, computer and upgrades. It should
 | 
			
		||||
     * be used before playing a movement animation using {@link #playAnimation(TurtleAnimation)}.
 | 
			
		||||
     * This will preserve the turtle's internal state, such as it's inventory, computer and upgrades. It should be used before playing a movement animation
 | 
			
		||||
     * using {@link #playAnimation(TurtleAnimation)}.
 | 
			
		||||
     *
 | 
			
		||||
     * @param world The new world to move it to
 | 
			
		||||
     * @param pos   The new position to move it to.
 | 
			
		||||
     * @return Whether the movement was successful. It may fail if the block was not loaded or the block placement
 | 
			
		||||
     * was cancelled. Note this will not check
 | 
			
		||||
     * {@link dan200.computercraft.api.permissions.ITurtlePermissionProvider#isBlockEnterable(World, BlockPos)}.
 | 
			
		||||
     * @param pos The new position to move it to.
 | 
			
		||||
     * @return Whether the movement was successful. It may fail if the block was not loaded or the block placement was cancelled.
 | 
			
		||||
     * @throws UnsupportedOperationException When attempting to teleport on the client side.
 | 
			
		||||
     */
 | 
			
		||||
    boolean teleportTo( @Nonnull World world, @Nonnull BlockPos pos );
 | 
			
		||||
    boolean teleportTo(@Nonnull World world, @Nonnull BlockPos pos);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns a vector containing the floating point co-ordinates at which the turtle is rendered.
 | 
			
		||||
     * This will shift when the turtle is moving.
 | 
			
		||||
     * Returns a vector containing the floating point co-ordinates at which the turtle is rendered. This will shift when the turtle is moving.
 | 
			
		||||
     *
 | 
			
		||||
     * @param f The subframe fraction.
 | 
			
		||||
     * @return A vector containing the floating point co-ordinates at which the turtle resides.
 | 
			
		||||
     * @see #getVisualYaw(float)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    Vec3d getVisualPosition( float f );
 | 
			
		||||
    Vec3d getVisualPosition(float f);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the yaw the turtle is facing when it is rendered.
 | 
			
		||||
@@ -77,25 +74,25 @@ public interface ITurtleAccess
 | 
			
		||||
     * @return The yaw the turtle is facing.
 | 
			
		||||
     * @see #getVisualPosition(float)
 | 
			
		||||
     */
 | 
			
		||||
    float getVisualYaw( float f );
 | 
			
		||||
    float getVisualYaw(float f);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the world direction the turtle is currently facing.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The world direction the turtle is currently facing.
 | 
			
		||||
     * @see #setDirection(EnumFacing)
 | 
			
		||||
     * @see #setDirection(Direction)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    EnumFacing getDirection();
 | 
			
		||||
    Direction getDirection();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Set the direction the turtle is facing. Note that this will not play a rotation animation, you will also need to
 | 
			
		||||
     * call {@link #playAnimation(TurtleAnimation)} to do so.
 | 
			
		||||
     * Set the direction the turtle is facing. Note that this will not play a rotation animation, you will also need to call {@link
 | 
			
		||||
     * #playAnimation(TurtleAnimation)} to do so.
 | 
			
		||||
     *
 | 
			
		||||
     * @param dir The new direction to set. This should be on either the x or z axis (so north, south, east or west).
 | 
			
		||||
     * @see #getDirection()
 | 
			
		||||
     */
 | 
			
		||||
    void setDirection( @Nonnull EnumFacing dir );
 | 
			
		||||
    void setDirection(@Nonnull Direction dir);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the currently selected slot in the turtle's inventory.
 | 
			
		||||
@@ -109,64 +106,38 @@ public interface ITurtleAccess
 | 
			
		||||
    /**
 | 
			
		||||
     * Set the currently selected slot in the turtle's inventory.
 | 
			
		||||
     *
 | 
			
		||||
     * @param slot The slot to set. This must be greater or equal to 0 and less than the inventory size. Otherwise no
 | 
			
		||||
     *             action will be taken.
 | 
			
		||||
     * @param slot The slot to set. This must be greater or equal to 0 and less than the inventory size. Otherwise no action will be taken.
 | 
			
		||||
     * @throws UnsupportedOperationException When attempting to change the slot on the client side.
 | 
			
		||||
     * @see #getInventory()
 | 
			
		||||
     * @see #getSelectedSlot()
 | 
			
		||||
     */
 | 
			
		||||
    void setSelectedSlot( int slot );
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Set the colour of the turtle to a RGB number.
 | 
			
		||||
     *
 | 
			
		||||
     * @param colour The colour this turtle should be changed to. This should be a RGB colour between {@code 0x000000}
 | 
			
		||||
     *               and {@code 0xFFFFFF} or -1 to reset to the default colour.
 | 
			
		||||
     * @see #getColour()
 | 
			
		||||
     */
 | 
			
		||||
    void setColour( int colour );
 | 
			
		||||
    void setSelectedSlot(int slot);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the colour of this turtle as a RGB number.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The colour this turtle is. This will be a RGB colour between {@code 0x000000} and {@code 0xFFFFFF} or
 | 
			
		||||
     * -1 if it has no colour.
 | 
			
		||||
     * @return The colour this turtle is. This will be a RGB colour between {@code 0x000000} and {@code 0xFFFFFF} or -1 if it has no colour.
 | 
			
		||||
     * @see #setColour(int)
 | 
			
		||||
     */
 | 
			
		||||
    int getColour();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Set the colour of the turtle to a RGB number.
 | 
			
		||||
     *
 | 
			
		||||
     * @param colour The colour this turtle should be changed to. This should be a RGB colour between {@code 0x000000} and {@code 0xFFFFFF} or -1 to
 | 
			
		||||
     *     reset to the default colour.
 | 
			
		||||
     * @see #getColour()
 | 
			
		||||
     */
 | 
			
		||||
    void setColour(int colour);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the player who owns this turtle, namely whoever placed it.
 | 
			
		||||
     *
 | 
			
		||||
     * @return This turtle's owner.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @Nullable
 | 
			
		||||
    GameProfile getOwningPlayer();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the inventory of this turtle.
 | 
			
		||||
     *
 | 
			
		||||
     * Note: this inventory should only be accessed and modified on the server thread.
 | 
			
		||||
     *
 | 
			
		||||
     * @return This turtle's inventory
 | 
			
		||||
     * @see #getItemHandler()
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    IInventory getInventory();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the inventory of this turtle as an {@link IItemHandlerModifiable}.
 | 
			
		||||
     *
 | 
			
		||||
     * Note: this inventory should only be accessed and modified on the server thread.
 | 
			
		||||
     *
 | 
			
		||||
     * @return This turtle's inventory
 | 
			
		||||
     * @see #getInventory()
 | 
			
		||||
     * @see IItemHandlerModifiable
 | 
			
		||||
     * @see net.minecraftforge.items.CapabilityItemHandler#ITEM_HANDLER_CAPABILITY
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    IItemHandlerModifiable getItemHandler();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Determine whether this turtle will require fuel when performing actions.
 | 
			
		||||
     *
 | 
			
		||||
@@ -186,8 +157,7 @@ public interface ITurtleAccess
 | 
			
		||||
    int getFuelLevel();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Set the fuel level to a new value. It is generally preferred to use {@link #consumeFuel(int)}} or {@link #addFuel(int)}
 | 
			
		||||
     * instead.
 | 
			
		||||
     * Set the fuel level to a new value. It is generally preferred to use {@link #consumeFuel(int)}} or {@link #addFuel(int)} instead.
 | 
			
		||||
     *
 | 
			
		||||
     * @param fuel The new amount of fuel. This must be between 0 and the fuel limit.
 | 
			
		||||
     * @see #getFuelLevel()
 | 
			
		||||
@@ -195,7 +165,7 @@ public interface ITurtleAccess
 | 
			
		||||
     * @see #addFuel(int)
 | 
			
		||||
     * @see #consumeFuel(int)
 | 
			
		||||
     */
 | 
			
		||||
    void setFuelLevel( int fuel );
 | 
			
		||||
    void setFuelLevel(int fuel);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the maximum amount of fuel a turtle can hold.
 | 
			
		||||
@@ -208,11 +178,11 @@ public interface ITurtleAccess
 | 
			
		||||
     * Removes some fuel from the turtles fuel supply. Negative numbers can be passed in to INCREASE the fuel level of the turtle.
 | 
			
		||||
     *
 | 
			
		||||
     * @param fuel The amount of fuel to consume.
 | 
			
		||||
     * @return Whether the turtle was able to consume the amount of fuel specified. Will return false if you supply a number
 | 
			
		||||
     * greater than the current fuel level of the turtle. No fuel will be consumed if {@code false} is returned.
 | 
			
		||||
     * @return Whether the turtle was able to consume the amount of fuel specified. Will return false if you supply a number greater than the current fuel
 | 
			
		||||
     *     level of the turtle. No fuel will be consumed if {@code false} is returned.
 | 
			
		||||
     * @throws UnsupportedOperationException When attempting to consume fuel on the client side.
 | 
			
		||||
     */
 | 
			
		||||
    boolean consumeFuel( int fuel );
 | 
			
		||||
    boolean consumeFuel(int fuel);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Increase the turtle's fuel level by the given amount.
 | 
			
		||||
@@ -220,40 +190,31 @@ public interface ITurtleAccess
 | 
			
		||||
     * @param fuel The amount to refuel with.
 | 
			
		||||
     * @throws UnsupportedOperationException When attempting to refuel on the client side.
 | 
			
		||||
     */
 | 
			
		||||
    void addFuel( int fuel );
 | 
			
		||||
    void addFuel(int fuel);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Adds a custom command to the turtles command queue. Unlike peripheral methods, these custom commands will be executed
 | 
			
		||||
     * on the main thread, so are guaranteed to be able to access Minecraft objects safely, and will be queued up
 | 
			
		||||
     * with the turtles standard movement and tool commands. An issued command will return an unique integer, which will
 | 
			
		||||
     * be supplied as a parameter to a "turtle_response" event issued to the turtle after the command has completed. Look at the
 | 
			
		||||
     * lua source code for "rom/apis/turtle" for how to build a lua wrapper around this functionality.
 | 
			
		||||
     * Adds a custom command to the turtles command queue. Unlike peripheral methods, these custom commands will be executed on the main thread, so are
 | 
			
		||||
     * guaranteed to be able to access Minecraft objects safely, and will be queued up with the turtles standard movement and tool commands. An issued
 | 
			
		||||
     * command will return an unique integer, which will be supplied as a parameter to a "turtle_response" event issued to the turtle after the command has
 | 
			
		||||
     * completed. Look at the lua source code for "rom/apis/turtle" for how to build a lua wrapper around this functionality.
 | 
			
		||||
     *
 | 
			
		||||
     * @param context The Lua context to pull events from.
 | 
			
		||||
     * @param command An object which will execute the custom command when its point in the queue is reached
 | 
			
		||||
     * @return The objects the command returned when executed. you should probably return these to the player
 | 
			
		||||
     * unchanged if called from a peripheral method.
 | 
			
		||||
     * @return The objects the command returned when executed. you should probably return these to the player unchanged if called from a peripheral method.
 | 
			
		||||
     * @throws UnsupportedOperationException When attempting to execute a command on the client side.
 | 
			
		||||
     * @throws LuaException                  If the user presses CTRL+T to terminate the current program while {@code executeCommand()} is
 | 
			
		||||
     *                                       waiting for an event, a "Terminated" exception will be thrown here.
 | 
			
		||||
     * @throws InterruptedException          If the user shuts down or reboots the computer while pullEvent() is waiting for an
 | 
			
		||||
     *                                       event, InterruptedException will be thrown. This exception must not be caught or
 | 
			
		||||
     *                                       intercepted, or the computer will leak memory and end up in a broken state.
 | 
			
		||||
     * @see ITurtleCommand
 | 
			
		||||
     * @see ILuaContext#pullEvent(String)
 | 
			
		||||
     * @see MethodResult#pullEvent(String, ILuaCallback)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    Object[] executeCommand( @Nonnull ILuaContext context, @Nonnull ITurtleCommand command ) throws LuaException, InterruptedException;
 | 
			
		||||
    MethodResult executeCommand(@Nonnull ITurtleCommand command);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Start playing a specific animation. This will prevent other turtle commands from executing until
 | 
			
		||||
     * it is finished.
 | 
			
		||||
     * Start playing a specific animation. This will prevent other turtle commands from executing until it is finished.
 | 
			
		||||
     *
 | 
			
		||||
     * @param animation The animation to play.
 | 
			
		||||
     * @throws UnsupportedOperationException When attempting to execute play an animation on the client side.
 | 
			
		||||
     * @see TurtleAnimation
 | 
			
		||||
     */
 | 
			
		||||
    void playAnimation( @Nonnull TurtleAnimation animation );
 | 
			
		||||
    void playAnimation(@Nonnull TurtleAnimation animation);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the turtle on the specified side of the turtle, if there is one.
 | 
			
		||||
@@ -263,16 +224,16 @@ public interface ITurtleAccess
 | 
			
		||||
     * @see #setUpgrade(TurtleSide, ITurtleUpgrade)
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    ITurtleUpgrade getUpgrade( @Nonnull TurtleSide side );
 | 
			
		||||
    ITurtleUpgrade getUpgrade(@Nonnull TurtleSide side);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Set the upgrade for a given side, resetting peripherals and clearing upgrade specific data.
 | 
			
		||||
     *
 | 
			
		||||
     * @param side    The side to set the upgrade on.
 | 
			
		||||
     * @param side The side to set the upgrade on.
 | 
			
		||||
     * @param upgrade The upgrade to set, may be {@code null} to clear.
 | 
			
		||||
     * @see #getUpgrade(TurtleSide)
 | 
			
		||||
     */
 | 
			
		||||
    void setUpgrade( @Nonnull TurtleSide side, @Nullable ITurtleUpgrade upgrade );
 | 
			
		||||
    void setUpgrade(@Nonnull TurtleSide side, @Nullable ITurtleUpgrade upgrade);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the peripheral created by the upgrade on the specified side of the turtle, if there is one.
 | 
			
		||||
@@ -281,27 +242,40 @@ public interface ITurtleAccess
 | 
			
		||||
     * @return The peripheral created by the upgrade on the specified side of the turtle, {@code null} if none exists.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    IPeripheral getPeripheral( @Nonnull TurtleSide side );
 | 
			
		||||
    IPeripheral getPeripheral(@Nonnull TurtleSide side);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get an upgrade-specific NBT compound, which can be used to store arbitrary data.
 | 
			
		||||
     *
 | 
			
		||||
     * This will be persisted across turtle restarts and chunk loads, as well as being synced to the client. You must
 | 
			
		||||
     * call {@link #updateUpgradeNBTData(TurtleSide)} after modifying it.
 | 
			
		||||
     * This will be persisted across turtle restarts and chunk loads, as well as being synced to the client. You must call {@link
 | 
			
		||||
     * #updateUpgradeNBTData(TurtleSide)} after modifying it.
 | 
			
		||||
     *
 | 
			
		||||
     * @param side The side to get the upgrade data for.
 | 
			
		||||
     * @return The upgrade-specific data.
 | 
			
		||||
     * @see #updateUpgradeNBTData(TurtleSide)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    NBTTagCompound getUpgradeNBTData( @Nullable TurtleSide side );
 | 
			
		||||
    CompoundTag getUpgradeNBTData(@Nullable TurtleSide side);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Mark the upgrade-specific data as dirty on a specific side. This is required for the data to be synced to the
 | 
			
		||||
     * client and persisted.
 | 
			
		||||
     * Mark the upgrade-specific data as dirty on a specific side. This is required for the data to be synced to the client and persisted.
 | 
			
		||||
     *
 | 
			
		||||
     * @param side The side to mark dirty.
 | 
			
		||||
     * @see #updateUpgradeNBTData(TurtleSide)
 | 
			
		||||
     */
 | 
			
		||||
    void updateUpgradeNBTData( @Nonnull TurtleSide side );
 | 
			
		||||
    void updateUpgradeNBTData(@Nonnull TurtleSide side);
 | 
			
		||||
 | 
			
		||||
    default ItemStorage getItemHandler() {
 | 
			
		||||
        return ItemStorage.wrap(this.getInventory());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the inventory of this turtle.
 | 
			
		||||
     *
 | 
			
		||||
     * Note: this inventory should only be accessed and modified on the server thread.
 | 
			
		||||
     *
 | 
			
		||||
     * @return This turtle's inventory
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    Inventory getInventory();
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,33 +3,31 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaContext;
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An interface for objects executing custom turtle commands, used with {@link ITurtleAccess#executeCommand(ILuaContext, ITurtleCommand)}.
 | 
			
		||||
 * An interface for objects executing custom turtle commands, used with {@link ITurtleAccess#executeCommand(ITurtleCommand)}.
 | 
			
		||||
 *
 | 
			
		||||
 * @see ITurtleAccess#executeCommand(ILuaContext, ITurtleCommand)
 | 
			
		||||
 * @see ITurtleAccess#executeCommand(ITurtleCommand)
 | 
			
		||||
 */
 | 
			
		||||
@FunctionalInterface
 | 
			
		||||
public interface ITurtleCommand
 | 
			
		||||
{
 | 
			
		||||
public interface ITurtleCommand {
 | 
			
		||||
    /**
 | 
			
		||||
     * Will be called by the turtle on the main thread when it is time to execute the custom command.
 | 
			
		||||
     *
 | 
			
		||||
     * The handler should either perform the work of the command, and return success, or return
 | 
			
		||||
     * failure with an error message to indicate the command cannot be executed at this time.
 | 
			
		||||
     * The handler should either perform the work of the command, and return success, or return failure with an error message to indicate the command cannot
 | 
			
		||||
     * be executed at this time.
 | 
			
		||||
     *
 | 
			
		||||
     * @param turtle Access to the turtle for whom the command was issued.
 | 
			
		||||
     * @return A result, indicating whether this action succeeded or not.
 | 
			
		||||
     * @see ITurtleAccess#executeCommand(ILuaContext, ITurtleCommand)
 | 
			
		||||
     * @see ITurtleAccess#executeCommand(ITurtleCommand)
 | 
			
		||||
     * @see TurtleCommandResult#success()
 | 
			
		||||
     * @see TurtleCommandResult#failure(String)
 | 
			
		||||
     * @see TurtleCommandResult
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    TurtleCommandResult execute( @Nonnull ITurtleAccess turtle );
 | 
			
		||||
    TurtleCommandResult execute(@Nonnull ITurtleAccess turtle);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,56 +3,38 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import dan200.computercraft.api.turtle.event.TurtleAttackEvent;
 | 
			
		||||
import dan200.computercraft.api.turtle.event.TurtleBlockEvent;
 | 
			
		||||
import net.minecraft.client.renderer.block.model.IBakedModel;
 | 
			
		||||
import net.minecraft.client.renderer.block.model.ModelResourceLocation;
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.EnumFacing;
 | 
			
		||||
import net.minecraft.util.ResourceLocation;
 | 
			
		||||
import net.minecraftforge.event.entity.player.AttackEntityEvent;
 | 
			
		||||
import net.minecraftforge.event.world.BlockEvent;
 | 
			
		||||
import net.minecraftforge.fml.relauncher.Side;
 | 
			
		||||
import net.minecraftforge.fml.relauncher.SideOnly;
 | 
			
		||||
import org.apache.commons.lang3.tuple.Pair;
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import javax.vecmath.Matrix4f;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.api.client.TransformedModel;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.item.ItemStack;
 | 
			
		||||
import net.minecraft.util.Identifier;
 | 
			
		||||
import net.minecraft.util.math.Direction;
 | 
			
		||||
 | 
			
		||||
import net.fabricmc.api.EnvType;
 | 
			
		||||
import net.fabricmc.api.Environment;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The primary interface for defining an update for Turtles. A turtle update
 | 
			
		||||
 * can either be a new tool, or a new peripheral.
 | 
			
		||||
 * The primary interface for defining an update for Turtles. A turtle update can either be a new tool, or a new peripheral.
 | 
			
		||||
 *
 | 
			
		||||
 * @see ComputerCraftAPI#registerTurtleUpgrade(ITurtleUpgrade)
 | 
			
		||||
 */
 | 
			
		||||
public interface ITurtleUpgrade
 | 
			
		||||
{
 | 
			
		||||
public interface ITurtleUpgrade {
 | 
			
		||||
    /**
 | 
			
		||||
     * Gets a unique identifier representing this type of turtle upgrade. eg: "computercraft:wireless_modem" or "my_mod:my_upgrade".
 | 
			
		||||
     * You should use a unique resource domain to ensure this upgrade is uniquely identified.
 | 
			
		||||
     * The turtle will fail registration if an already used ID is specified.
 | 
			
		||||
     * Gets a unique identifier representing this type of turtle upgrade. eg: "computercraft:wireless_modem" or "my_mod:my_upgrade". You should use a unique
 | 
			
		||||
     * resource domain to ensure this upgrade is uniquely identified. The turtle will fail registration if an already used ID is specified.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The unique ID for this upgrade.
 | 
			
		||||
     * @see ComputerCraftAPI#registerTurtleUpgrade(ITurtleUpgrade)
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    ResourceLocation getUpgradeID();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Gets a numerical identifier representing this type of turtle upgrade,
 | 
			
		||||
     * for backwards compatibility with pre-1.76 worlds. If your upgrade was
 | 
			
		||||
     * not released for older ComputerCraft versions, you can return -1 here.
 | 
			
		||||
     * The turtle will fail registration if an already used positive ID is specified.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The legacy ID, or -1 if is needed.
 | 
			
		||||
     * @see ComputerCraftAPI#registerTurtleUpgrade(ITurtleUpgrade)
 | 
			
		||||
     */
 | 
			
		||||
    int getLegacyUpgradeID();
 | 
			
		||||
    Identifier getUpgradeID();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Return an unlocalised string to describe this type of turtle in turtle item names.
 | 
			
		||||
@@ -74,12 +56,11 @@ public interface ITurtleUpgrade
 | 
			
		||||
    TurtleUpgradeType getType();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Return an item stack representing the type of item that a turtle must be crafted
 | 
			
		||||
     * with to create a turtle which holds this upgrade. This item stack is also used
 | 
			
		||||
     * to determine the upgrade given by {@code turtle.equip()}
 | 
			
		||||
     * Return an item stack representing the type of item that a turtle must be crafted with to create a turtle which holds this upgrade. This item stack is
 | 
			
		||||
     * also used to determine the upgrade given by {@code turtle.equip()}
 | 
			
		||||
     *
 | 
			
		||||
     * Ideally this should be constant over a session. It is recommended that you cache
 | 
			
		||||
     * the item too, in order to prevent constructing it every time the method is called.
 | 
			
		||||
     * Ideally this should be constant over a session. It is recommended that you cache the item too, in order to prevent constructing it every time the
 | 
			
		||||
     * method is called.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The item stack to craft with, or {@link ItemStack#EMPTY} if it cannot be crafted.
 | 
			
		||||
     */
 | 
			
		||||
@@ -89,68 +70,52 @@ public interface ITurtleUpgrade
 | 
			
		||||
    /**
 | 
			
		||||
     * Will only be called for peripheral upgrades. Creates a peripheral for a turtle being placed using this upgrade.
 | 
			
		||||
     *
 | 
			
		||||
     * The peripheral created will be stored for the lifetime of the upgrade and will be passed as an argument to
 | 
			
		||||
     * {@link #update(ITurtleAccess, TurtleSide)}. It will be attached, detached and have methods called in the same
 | 
			
		||||
     * manner as a Computer peripheral.
 | 
			
		||||
     * The peripheral created will be stored for the lifetime of the upgrade and will be passed as an argument to {@link #update(ITurtleAccess,
 | 
			
		||||
     * TurtleSide)}. It will be attached, detached and have methods called in the same manner as a Computer peripheral.
 | 
			
		||||
     *
 | 
			
		||||
     * @param turtle Access to the turtle that the peripheral is being created for.
 | 
			
		||||
     * @param side   Which side of the turtle (left or right) that the upgrade resides on.
 | 
			
		||||
     * @return The newly created peripheral. You may return {@code null} if this upgrade is a Tool
 | 
			
		||||
     * and this method is not expected to be called.
 | 
			
		||||
     * @param side Which side of the turtle (left or right) that the upgrade resides on.
 | 
			
		||||
     * @return The newly created peripheral. You may return {@code null} if this upgrade is a Tool and this method is not expected to be called.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    default IPeripheral createPeripheral( @Nonnull ITurtleAccess turtle, @Nonnull TurtleSide side )
 | 
			
		||||
    {
 | 
			
		||||
    default IPeripheral createPeripheral(@Nonnull ITurtleAccess turtle, @Nonnull TurtleSide side) {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Will only be called for Tool turtle. Called when turtle.dig() or turtle.attack() is called
 | 
			
		||||
     * by the turtle, and the tool is required to do some work.
 | 
			
		||||
     * Will only be called for Tool turtle. Called when turtle.dig() or turtle.attack() is called by the turtle, and the tool is required to do some work.
 | 
			
		||||
     *
 | 
			
		||||
     * Conforming implementations should fire {@link BlockEvent.BreakEvent} and {@link TurtleBlockEvent.Dig} for
 | 
			
		||||
     * digging, {@link AttackEntityEvent} and {@link TurtleAttackEvent} for attacking.
 | 
			
		||||
     *
 | 
			
		||||
     * @param turtle    Access to the turtle that the tool resides on.
 | 
			
		||||
     * @param side      Which side of the turtle (left or right) the tool resides on.
 | 
			
		||||
     * @param verb      Which action (dig or attack) the turtle is being called on to perform.
 | 
			
		||||
     * @param direction Which world direction the action should be performed in, relative to the turtles
 | 
			
		||||
     *                  position. This will either be up, down, or the direction the turtle is facing, depending on
 | 
			
		||||
     *                  whether dig, digUp or digDown was called.
 | 
			
		||||
     * @return Whether the turtle was able to perform the action, and hence whether the {@code turtle.dig()}
 | 
			
		||||
     * or {@code turtle.attack()} lua method should return true. If true is returned, the tool will perform
 | 
			
		||||
     * a swinging animation. You may return {@code null} if this turtle is a Peripheral  and this method is not expected
 | 
			
		||||
     * to be called.
 | 
			
		||||
     * @param turtle Access to the turtle that the tool resides on.
 | 
			
		||||
     * @param side Which side of the turtle (left or right) the tool resides on.
 | 
			
		||||
     * @param verb Which action (dig or attack) the turtle is being called on to perform.
 | 
			
		||||
     * @param direction Which world direction the action should be performed in, relative to the turtles position. This will either be up, down, or the
 | 
			
		||||
     *     direction the turtle is facing, depending on whether dig, digUp or digDown was called.
 | 
			
		||||
     * @return Whether the turtle was able to perform the action, and hence whether the {@code turtle.dig()} or {@code turtle.attack()} lua method should
 | 
			
		||||
     *     return true. If true is returned, the tool will perform a swinging animation. You may return {@code null} if this turtle is a Peripheral  and
 | 
			
		||||
     *     this method is not expected to be called.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    default TurtleCommandResult useTool( @Nonnull ITurtleAccess turtle, @Nonnull TurtleSide side, @Nonnull TurtleVerb verb, @Nonnull EnumFacing direction )
 | 
			
		||||
    {
 | 
			
		||||
    default TurtleCommandResult useTool(@Nonnull ITurtleAccess turtle, @Nonnull TurtleSide side, @Nonnull TurtleVerb verb, @Nonnull Direction direction) {
 | 
			
		||||
        return TurtleCommandResult.failure();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Called to obtain the model to be used when rendering a turtle peripheral.
 | 
			
		||||
     *
 | 
			
		||||
     * This can be obtained from {@link net.minecraft.client.renderer.ItemModelMesher#getItemModel(ItemStack)},
 | 
			
		||||
     * {@link net.minecraft.client.renderer.block.model.ModelManager#getModel(ModelResourceLocation)} or any other
 | 
			
		||||
     * source.
 | 
			
		||||
     *
 | 
			
		||||
     * @param turtle Access to the turtle that the upgrade resides on. This will be null when getting item models!
 | 
			
		||||
     * @param side   Which side of the turtle (left or right) the upgrade resides on.
 | 
			
		||||
     * @return The model that you wish to be used to render your upgrade, and a transformation to apply to it. Returning
 | 
			
		||||
     * a transformation of {@code null} has the same effect as the identify matrix.
 | 
			
		||||
     * @param side Which side of the turtle (left or right) the upgrade resides on.
 | 
			
		||||
     * @return The model that you wish to be used to render your upgrade.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    @SideOnly( Side.CLIENT )
 | 
			
		||||
    Pair<IBakedModel, Matrix4f> getModel( @Nullable ITurtleAccess turtle, @Nonnull TurtleSide side );
 | 
			
		||||
    @Environment (EnvType.CLIENT)
 | 
			
		||||
    TransformedModel getModel(@Nullable ITurtleAccess turtle, @Nonnull TurtleSide side);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Called once per tick for each turtle which has the upgrade equipped.
 | 
			
		||||
     *
 | 
			
		||||
     * @param turtle Access to the turtle that the upgrade resides on.
 | 
			
		||||
     * @param side   Which side of the turtle (left or right) the upgrade resides on.
 | 
			
		||||
     * @param side Which side of the turtle (left or right) the upgrade resides on.
 | 
			
		||||
     */
 | 
			
		||||
    default void update( @Nonnull ITurtleAccess turtle, @Nonnull TurtleSide side )
 | 
			
		||||
    {
 | 
			
		||||
    default void update(@Nonnull ITurtleAccess turtle, @Nonnull TurtleSide side) {
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,6 +3,7 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
@@ -12,75 +13,70 @@ package dan200.computercraft.api.turtle;
 | 
			
		||||
 *
 | 
			
		||||
 * @see ITurtleAccess#playAnimation(TurtleAnimation)
 | 
			
		||||
 */
 | 
			
		||||
public enum TurtleAnimation
 | 
			
		||||
{
 | 
			
		||||
public enum TurtleAnimation {
 | 
			
		||||
    /**
 | 
			
		||||
     * An animation which does nothing. This takes no time to complete.
 | 
			
		||||
     *
 | 
			
		||||
     * @see #Wait
 | 
			
		||||
     * @see #ShortWait
 | 
			
		||||
     * @see #WAIT
 | 
			
		||||
     * @see #SHORT_WAIT
 | 
			
		||||
     */
 | 
			
		||||
    None,
 | 
			
		||||
    NONE,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Make the turtle move forward. Note that the animation starts from the block <em>behind</em> it, and
 | 
			
		||||
     * moves into this one.
 | 
			
		||||
     * Make the turtle move forward. Note that the animation starts from the block <em>behind</em> it, and moves into this one.
 | 
			
		||||
     */
 | 
			
		||||
    MoveForward,
 | 
			
		||||
    MOVE_FORWARD,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Make the turtle move backwards. Note that the animation starts from the block <em>in front</em> it, and
 | 
			
		||||
     * moves into this one.
 | 
			
		||||
     * Make the turtle move backwards. Note that the animation starts from the block <em>in front</em> it, and moves into this one.
 | 
			
		||||
     */
 | 
			
		||||
    MoveBack,
 | 
			
		||||
    MOVE_BACK,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Make the turtle move backwards. Note that the animation starts from the block <em>above</em> it, and
 | 
			
		||||
     * moves into this one.
 | 
			
		||||
     * Make the turtle move backwards. Note that the animation starts from the block <em>above</em> it, and moves into this one.
 | 
			
		||||
     */
 | 
			
		||||
    MoveUp,
 | 
			
		||||
    MOVE_UP,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Make the turtle move backwards. Note that the animation starts from the block <em>below</em> it, and
 | 
			
		||||
     * moves into this one.
 | 
			
		||||
     * Make the turtle move backwards. Note that the animation starts from the block <em>below</em> it, and moves into this one.
 | 
			
		||||
     */
 | 
			
		||||
    MoveDown,
 | 
			
		||||
    MOVE_DOWN,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Turn the turtle to the left. Note that the animation starts with the turtle facing <em>right</em>, and
 | 
			
		||||
     * the turtle turns to face in the current direction.
 | 
			
		||||
     * Turn the turtle to the left. Note that the animation starts with the turtle facing <em>right</em>, and the turtle turns to face in the current
 | 
			
		||||
     * direction.
 | 
			
		||||
     */
 | 
			
		||||
    TurnLeft,
 | 
			
		||||
    TURN_LEFT,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Turn the turtle to the left. Note that the animation starts with the turtle facing <em>right</em>, and
 | 
			
		||||
     * the turtle turns to face in the current direction.
 | 
			
		||||
     * Turn the turtle to the left. Note that the animation starts with the turtle facing <em>right</em>, and the turtle turns to face in the current
 | 
			
		||||
     * direction.
 | 
			
		||||
     */
 | 
			
		||||
    TurnRight,
 | 
			
		||||
    TURN_RIGHT,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Swing the tool on the left.
 | 
			
		||||
     */
 | 
			
		||||
    SwingLeftTool,
 | 
			
		||||
    SWING_LEFT_TOOL,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Swing the tool on the right.
 | 
			
		||||
     */
 | 
			
		||||
    SwingRightTool,
 | 
			
		||||
    SWING_RIGHT_TOOL,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Wait until the animation has finished, performing no movement.
 | 
			
		||||
     *
 | 
			
		||||
     * @see #ShortWait
 | 
			
		||||
     * @see #None
 | 
			
		||||
     * @see #SHORT_WAIT
 | 
			
		||||
     * @see #NONE
 | 
			
		||||
     */
 | 
			
		||||
    Wait,
 | 
			
		||||
    WAIT,
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Wait until the animation has finished, performing no movement. This takes 4 ticks to complete.
 | 
			
		||||
     *
 | 
			
		||||
     * @see #Wait
 | 
			
		||||
     * @see #None
 | 
			
		||||
     * @see #WAIT
 | 
			
		||||
     * @see #NONE
 | 
			
		||||
     */
 | 
			
		||||
    ShortWait,
 | 
			
		||||
    SHORT_WAIT,
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,9 +3,8 @@
 | 
			
		||||
 * Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
 | 
			
		||||
 * For help using the API, and posting your mods, visit the forums at computercraft.info.
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.util.EnumFacing;
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nonnull;
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
@@ -14,12 +13,20 @@ import javax.annotation.Nullable;
 | 
			
		||||
 * Used to indicate the result of executing a turtle command.
 | 
			
		||||
 *
 | 
			
		||||
 * @see ITurtleCommand#execute(ITurtleAccess)
 | 
			
		||||
 * @see ITurtleUpgrade#useTool(ITurtleAccess, TurtleSide, TurtleVerb, EnumFacing)
 | 
			
		||||
 * @see ITurtleUpgrade#useTool(ITurtleAccess, TurtleSide, TurtleVerb, Direction)
 | 
			
		||||
 */
 | 
			
		||||
public final class TurtleCommandResult
 | 
			
		||||
{
 | 
			
		||||
    private static final TurtleCommandResult EMPTY_SUCCESS = new TurtleCommandResult( true, null, null );
 | 
			
		||||
    private static final TurtleCommandResult EMPTY_FAILURE = new TurtleCommandResult( false, null, null );
 | 
			
		||||
public final class TurtleCommandResult {
 | 
			
		||||
    private static final TurtleCommandResult EMPTY_SUCCESS = new TurtleCommandResult(true, null, null);
 | 
			
		||||
    private static final TurtleCommandResult EMPTY_FAILURE = new TurtleCommandResult(false, null, null);
 | 
			
		||||
    private final boolean success;
 | 
			
		||||
    private final String errorMessage;
 | 
			
		||||
    private final Object[] results;
 | 
			
		||||
 | 
			
		||||
    private TurtleCommandResult(boolean success, String errorMessage, Object[] results) {
 | 
			
		||||
        this.success = success;
 | 
			
		||||
        this.errorMessage = errorMessage;
 | 
			
		||||
        this.results = results;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Create a successful command result with no result.
 | 
			
		||||
@@ -27,8 +34,7 @@ public final class TurtleCommandResult
 | 
			
		||||
     * @return A successful command result with no values.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static TurtleCommandResult success()
 | 
			
		||||
    {
 | 
			
		||||
    public static TurtleCommandResult success() {
 | 
			
		||||
        return EMPTY_SUCCESS;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -39,10 +45,11 @@ public final class TurtleCommandResult
 | 
			
		||||
     * @return A successful command result with the given values.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static TurtleCommandResult success( @Nullable Object[] results )
 | 
			
		||||
    {
 | 
			
		||||
        if( results == null || results.length == 0 ) return EMPTY_SUCCESS;
 | 
			
		||||
        return new TurtleCommandResult( true, null, results );
 | 
			
		||||
    public static TurtleCommandResult success(@Nullable Object[] results) {
 | 
			
		||||
        if (results == null || results.length == 0) {
 | 
			
		||||
            return EMPTY_SUCCESS;
 | 
			
		||||
        }
 | 
			
		||||
        return new TurtleCommandResult(true, null, results);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -51,8 +58,7 @@ public final class TurtleCommandResult
 | 
			
		||||
     * @return A failed command result with no message.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static TurtleCommandResult failure()
 | 
			
		||||
    {
 | 
			
		||||
    public static TurtleCommandResult failure() {
 | 
			
		||||
        return EMPTY_FAILURE;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -63,21 +69,11 @@ public final class TurtleCommandResult
 | 
			
		||||
     * @return A failed command result with a message.
 | 
			
		||||
     */
 | 
			
		||||
    @Nonnull
 | 
			
		||||
    public static TurtleCommandResult failure( @Nullable String errorMessage )
 | 
			
		||||
    {
 | 
			
		||||
        if( errorMessage == null ) return EMPTY_FAILURE;
 | 
			
		||||
        return new TurtleCommandResult( false, errorMessage, null );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private final boolean success;
 | 
			
		||||
    private final String errorMessage;
 | 
			
		||||
    private final Object[] results;
 | 
			
		||||
 | 
			
		||||
    private TurtleCommandResult( boolean success, String errorMessage, Object[] results )
 | 
			
		||||
    {
 | 
			
		||||
        this.success = success;
 | 
			
		||||
        this.errorMessage = errorMessage;
 | 
			
		||||
        this.results = results;
 | 
			
		||||
    public static TurtleCommandResult failure(@Nullable String errorMessage) {
 | 
			
		||||
        if (errorMessage == null) {
 | 
			
		||||
            return EMPTY_FAILURE;
 | 
			
		||||
        }
 | 
			
		||||
        return new TurtleCommandResult(false, errorMessage, null);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -85,9 +81,8 @@ public final class TurtleCommandResult
 | 
			
		||||
     *
 | 
			
		||||
     * @return If the command was successful.
 | 
			
		||||
     */
 | 
			
		||||
    public boolean isSuccess()
 | 
			
		||||
    {
 | 
			
		||||
        return success;
 | 
			
		||||
    public boolean isSuccess() {
 | 
			
		||||
        return this.success;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -96,9 +91,8 @@ public final class TurtleCommandResult
 | 
			
		||||
     * @return The command's error message, or {@code null} if it was a success.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public String getErrorMessage()
 | 
			
		||||
    {
 | 
			
		||||
        return errorMessage;
 | 
			
		||||
    public String getErrorMessage() {
 | 
			
		||||
        return this.errorMessage;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -107,8 +101,7 @@ public final class TurtleCommandResult
 | 
			
		||||
     * @return The command's result, or {@code null} if it was a failure.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public Object[] getResults()
 | 
			
		||||
    {
 | 
			
		||||
        return results;
 | 
			
		||||
    public Object[] getResults() {
 | 
			
		||||
        return this.results;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user