User Manual: Scripts

The Scripting User Interface (SUI) of Energy2D allows it to communicate with external programs such as JavaScript. Script commands are listed in the following categories ({arg} means an argument to be set by the scripter):

Simulation controls

  • run
  • runsteps {arg}
  • stop
  • reset
  • init
  • reload
  • delay {arg}
  • load {arg}

Model properties

  • set timestep {arg}
  • set convective {arg}
  • set sunny {arg}

Object properties

  • set part[{arg}].uid {arg}
  • set part[{arg}].label {arg}
  • set part[{arg}].x {arg}
  • set part[{arg}].y {arg}
  • set part[{arg}].width {arg}
  • set part[{arg}].height {arg}
  • set part[{arg}].thermal_conductivity {arg}
  • set part[{arg}].specific_heat {arg}
  • set part[{arg}].density {arg}
  • set part[{arg}].power {arg}
  • set part[{arg}].wind_speed {arg}
  • set part[{arg}].wind_angle {arg}
  • set part[{arg}].temperature {arg}
  • set part[{arg}].color {arg}
  • set part[{arg}].filled {arg}
  • set part[{arg}].draggable {arg}
  • set part[{arg}].transmission {arg}
  • set part[{arg}].absorption {arg}
  • set part[{arg}].reflection {arg}
  • set part[{arg}].emissivity {arg}
  • set part[{arg}].constant_temperature {arg}

Editing

  • set action {arg}
  • remove {arg}

View options

  • set color_palette {arg}
  • set color_palette_type {arg}
  • set clock {arg}
  • set ruler {arg}
  • set graph {arg}
  • set graph_xlabel {arg}
  • set graph_ylabel {arg}
  • set isotherm {arg}
  • set isotherm_resolution {arg}
  • set streamline {arg}
  • set velocity {arg}
  • set heat_flux_arrow {arg}
  • set heat_flux_line {arg}
  • set heat_map {arg}
  • set minimum_temperature {arg}
  • set maximum_temperature {arg}
  • set mouse_read {arg}
  • set grid {arg}
  • set grid_size {arg}
  • set see-through {arg}

Miscellaneous

  • message {arg}


Developed by Charles Xie. © 2010- The Concord Consortium.