index :: local

local.list

local named list object

available since version: 0.1

---

information

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

arguments:

• ID object ID
  type: symbol
  

• VALUE initial values
  type: list
  

methods:

• append adds values to the end of the list
  parameters:
  • VAL appended value
    type: atom
    required: True
    
• at outputs atom at the specified position
  parameters:
  • IDX position (negative indexes are supported: -1 means last element)
    type: int
    required: True
    

• back output last list element
  

• choose choose random element in list and output it
  

• clear removes all list elements
  

• dump dump object info to Pd window
  

• fill fills with specified value
  parameters:
  • VAL fill value
    type: atom
    required: True
    

• front output first list element
  

• insert inserts values to the specified position
  parameters:

  • IDX insert position
    type: int
    required: True
    

  • VAL value
    type: atom
    required: True
    

• pop removes last list element
  

• prepend inserts values to the list beginning
  parameters:
  • VAL prepended value
    type: atom
    required: True
    
• remove removes specified element
  parameters:
  • IDX element index
    type: int
    required: True
    

• reverse reverses list
  

• set sets new list without output
  parameters:
  • LIST new list content
    type: list
    required: True
    

• shuffle put elements in random order
  

• sort sorts list
  

properties:

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

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

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

• @value Get/set current value
  type: list
  

inlets:

• output list content
  type: control

outlets:

• list output
  type: control

keywords:

list global

See also: [local.float] [local.int]

Authors: Serge Poltavsky

License: GPL3 or later