index :: local

local.dict

aliases: [local.json]

local named dict object

available since version: 0.6

---

information

Defines local scope dict variable, accessed by ID name and available only within its patch (canvas)

arguments:

• ID object ID
  type: symbol
  

methods:

• [….] sets new content without output
  

• add adds entry to dictionary
  parameters:

  • KEY entry key
    type: atom
    required: True
    

  • VAL single value or list
    type: list
    required: True
    

• choose choose random key and output it
  

• clear removes all dict values. No output
  

• get_key get entry from dictionary
  parameters:
  • KEY entry key
    type: atom
    required: True
    
• read read dict from JSON file
  parameters:
  • PATH file path
    type: symbol
    required: True
    
• remove remove entry from dictionary
  parameters:
  • KEY entry key
    type: atom
    required: True
    

• set set dict content without output
  

• set_key change entry in dictionary. If it's not exists, do nothing.
  parameters:

  • KEY key
    type: atom
    required: True
    

  • VAL single value or list
    type: list
    required: True
    

• write write dict as JSON file
  parameters:
  • PATH file path
    type: symbol
    required: True
    

properties:

• @id (initonly) Get/set local variable id
  type: symbol
  default: default
  

• @keys (readonly) Get keys of dictionary
  type: list
  

• @empty (readonly) Get 1 if dict is empty, otherwise 0
  type: bool
  default: 1
  

• @size (readonly) Get number of entries in dictionary
  type: int
  min value: 0
  default: 0
  

inlets:

• output current dictionary value
  type: control

outlets:

• dict output
  type: control

keywords:

dict local global

See also: [data.dict] [global.dict]

Authors: Serge Poltavsky

License: GPL3 or later