My Neighbor Alice/plot_nodes

Module-level declarations

Types

base_node_prototype

entity base_node_prototype

module_args

struct module_args

node

entity node

node_action_dto

struct node_action_dto

node_dto

struct node_dto

node_prototype_dto

struct node_prototype_dto

node_prototype_type

enum node_prototype_type

place_node_dto

struct place_node_dto

plot_nodes_config

object plot_nodes_config

relocate_node_dto

struct relocate_node_dto

Properties

CELLS_TO_IGNORE_PARAM

val CELLS_TO_IGNORE_PARAM: text = "cells_to_ignore"

Functions

_get_required_key

function _get_required_key(args: map<text, gtv>, attribute_name: text): gtv

_place_plot_node

function _place_plot_node(node_prototype_name: text, location: location, rotation: grid_rotation, plot: instance, plot_id: integer): node

deplete_node

@extendable function deplete_node(node: node, args: map<text, gtv>)

generate_node_attrs

@extendable function generate_node_attrs(node: node): map<text, gtv>

generate_prototype_attrs

@extendable function generate_prototype_attrs(base_node_prototype: base_node_prototype): map<text, gtv>

get_active_replenish_duration

function get_active_replenish_duration(configured_replenish_duration: integer): integer

get_all_cells_for_plot_node

function get_all_cells_for_plot_node(width: integer, height: integer, location: location, rotation: grid_rotation): set<location>

get_all_cells_for_plot_nodes

function get_all_cells_for_plot_nodes(plot_nodes: list<node>): set<location>

on_node_creation

@extendable function on_node_creation(node: node, node_prototype_name: text, args: map<text, gtv>)

on_node_prototype_creation

@extendable function on_node_prototype_creation(base_node_prototype: base_node_prototype, args: map<text, gtv>)

on_node_prototype_update

@extendable function on_node_prototype_update(base_node_prototype: base_node_prototype, args: map<text, gtv>)

recharge_node

@extendable function recharge_node(node: node)

require_occupancy_based_on_locations

@extend(require_occupancy_based_on_locations) function require_occupancy_based_on_locations(griddable: instance, locations: set<location>, optional_params: map<text, byte_array>)

Queries

get_global_plot_nodes_config

@mount("plot_nodes.get_global_plot_nodes_config") query get_global_plot_nodes_config(): (enabled: boolean,)

get_node_prototypes

@mount("plot_nodes.get_node_prototypes") query get_node_prototypes(): list<node_prototype_dto>

get_nodes_on_plot

@mount("plot_nodes.get_nodes_on_plot") query get_nodes_on_plot(plot_id: integer): list<node_dto>

Operations

create_node_prototype

@mount("plot_nodes.create_node_prototype") operation create_node_prototype(node_prototype_type: node_prototype_type, name: text, width: integer, height: integer, args: map<text, gtv>)

place_nodes_on_plot

@mount("plot_nodes.place_nodes_on_plot") operation place_nodes_on_plot(plot_id: integer, plot_nodes: list<place_node_dto>)

relocate

@mount("plot_nodes.relocate") operation relocate(account_id: byte_array, auth_descriptor_id: byte_array, relocate_actions: list<relocate_node_dto>)

set_global_plot_nodes_config

@mount("plot_nodes.set_global_plot_nodes_config") operation set_global_plot_nodes_config(enabled: boolean)

update_node_prototype

@mount("plot_nodes.update_node_prototype") operation update_node_prototype(name: text, width: integer, height: integer, args: map<text, gtv>)