https://github.com/samolego/taterzenscarpetprofessions

Professions for Taterzens powered by Scarpet lang.
https://github.com/samolego/taterzenscarpetprofessions

Last synced: 24 days ago
JSON representation

Professions for Taterzens powered by Scarpet lang.

• Host: GitHub
• URL: https://github.com/samolego/taterzenscarpetprofessions
• Owner: samolego
• License: unlicense
• Created: 2021-10-26T19:46:01.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-07-10T13:51:14.000Z (over 2 years ago)
• Last Synced: 2024-10-15T06:26:07.980Z (2 months ago)
• Language: Scala
• Size: 13.7 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TaterzenScarpetProfessions

Professions for [Taterzens](https://github.com/samolego/Taterzens) powered by [Scarpet lang](https://github.com/gnembon/fabric-carpet/wiki/Scarpet).

## How-to

0. Install fabric-carpet and taterzens mods.

1.  * download the script professions you want and put them in `world/scripts`

    * use `/carpet scriptsAppStore samolego/TaterzenScarpetProfessions/contents/scripts`, followed by `/script download `

3. Run the server.

4. Make sure the script is loaded (`/script load <script name>`). (To autoload the scripts, use `/carpet setDefault scriptsAutoload true`)

5. Give taterzen the `taterzens:scarpet_profession` (`/npc edit professions add taterzens:scarpet_profession`).

6. Set the scarpet traits if needed (`/profession scarpetTraits add <trait name>`).

7. Enjoy and modify scripts to your needs.

## Developers

Feel free to fork the repo and add any scripts for taterzens!

#### What is the `trait` parameter?

Let's assume you have two taterzens; `foo` and `bar`. `bar` can trade use items using [`merchant`](https://github.com/samolego/TaterzenScarpetProfessions/blob/master/scripts/merchant.sc) script and `foo` prints the picked up item name with `printitem.sc`

(both respond to `__on_taterzen_tries_pickup` event).

Since a taterzen can only have 1 `scarpet_profession`, you can't distinguish whether an event was triggered by a taterzen that should

respond to it or not - e.g. when `bar` picks up an item

1. The `__on_taterzen_tries_pickup` is triggered.

2. Both event listeners (`merchant.sc` and `printitem.sc`) get called.

How can we execute only the `merchant.sc` event on `bar`?

Here's where traits come in place. In your script, check if taterzen has an e.g. `merchant` trait.

If it's not present, just use `return()`.

```python

if( (traits ~ 'merchant' == null),

    return();  // 'merchant' trait not present

);

```

## Available events

See [github source page](https://github.com/samolego/Taterzens/blob/master/fabric/src/main/java/org/samo_lego/taterzens/fabric/compatibility/carpet/ScarpetProfession.java).

All events start with `__on_<event name>`.

You can also use the events below to add them in [IDEA highlighting](https://github.com/gnembon/fabric-carpet/blob/master/docs/scarpet/resources/editors/idea/Idea.md).

```python

__on_taterzen_tries_pickup(taterzen, traits, item) ->

__on_taterzen_interacted(taterzen, traits, item) ->

__on_taterzen_is_attacked(taterzen, traits, attacker) ->

__on_taterzen_movement_ticks(taterzen, traits) ->

__on_taterzen_removed(taterzen, traits) ->

__on_taterzen_nbt_loaded(taterzen, traits, nbt) ->

__on_taterzen_nbt_saved(taterzen, traits, nbt) ->

__on_taterzen_movement_set(taterzen, traits, movement_type) ->

__on_taterzen_taterzen_behaviour_set(taterzen, traits, behaviour_type) ->

__on_taterzen_tries_ranged_attack(taterzen, traits, target_entity) ->

__on_taterzen_tries_melee_attack(taterzen, traits, target_entity) ->

__on_taterzen_approached_by(taterzen, traits, player_list) ->

```