Index: 09_appendix/action_reference.html =================================================================== --- 09_appendix/action_reference.html (revision 31732) +++ 09_appendix/action_reference.html (revision 31733) @@ -13,7 +13,7 @@
Action | Description | Syntax | Plugin |
---|---|---|---|
About | Present the about box | About() | dialogs plugin | @@ -237,9 +237,10 @@
MoveObject | Moves the object under the crosshair. | pcb_move_obj(X,Y,[units]) | |
MoveToCurrentLayer | Moves objects to the current layer. | MoveToCurrentLayer(Object|SelectedObjects) | |
net | Perform various actions on netlists. | Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]]) Net(freeze|thaw|forcethaw) Net(swap) Net(add,net,pin)Net([rename|merge],srcnet,dstnet) | + |
NetLength | Report physical network length | NetLength(clear) NetLength(object) | report plugin |
netlist | Perform various actions on netlists. | Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]]) Net(freeze|thaw|forcethaw) Net(swap) Net(add,net,pin)Net([rename|merge],srcnet,dstnet) | |
NetlistChanged | Tells the GUI that the netlist has changed. | NetlistChanged() | oldactions plugin | -
NetlistDialog | Open the netlist dialog. | NetlistDialog() | dialogs plugin | +
NetlistDialog | Open the netlist dialog or refresh network lengths in an already open dialog. | NetlistDialog([RefreshNetLens]) | dialogs plugin |
New | Starts a new layout. | New([name]) | |
NewGroup | Create a new layer group with a single, positive drawn layer in it | NewGroup(type [,location [, purpose[, auto|sub [,name[,grp_attribs]]]]) | |
Normalize | Move all objects within the drawing area (or buffer 0;0), align the drawing to 0;0 (or set buffer grab point to 0;0) | Normalize([board|buffer[n]]) | @@ -268,6 +269,7 @@ |
pcb_tan | script plugin | ||
perp | Draw a line perpendicular to another line | perp() | ddraft plugin |
Pinout | Present the subcircuit pinout box | Pinout() | dialogs plugin | +
PolyBool | Perform polygon boolean operation on the clipped polygons referred. A poly is either and idpath, selected, found or object (for the object under the cursor). When not specified, two object polygons are used. | PstkProto([noundo,] unite|isect|sub|xor, [poly1, poly2, [poly...]]) | act_draw |
PolyCombine | polycombine plugin | ||
Polygon | Some polygon related stuff. | Polygon(Close|CloseHole|PreviousPoint) | |
PolyHatch | hatch the selected polygon(s) with lines of the current style; lines are drawn on the current layer; flags are h:horizontal, v:vertical, c:contour, p:poly | PolyHatch([spacing], [hvcp]) PolyHatch(interactive) | lib_polyhelp | @@ -304,6 +306,7 @@
q! | Quits the application without confirming. | q! | shand_cmd plugin |
q | Quits the application after confirming. | q | shand_cmd plugin |
query | Perform various queries on PCB data. | query(dump, expr) - dry run: compile and dump an expression query(eval|evalidp, expr) - compile and evaluate an expression and print a list of results on stdout query(select|unselect|view, expr) - select or unselect or build a view of objects matching an expression query(setflag:flag|unsetflag:flag, expr) - set or unset a named flag on objects matching an expression query(append, idplist, expr) - compile and run expr and append the idpath of resulting objects on idplist | query plugin | +
QueryCalcNetLen | Calculates the network length by netname; returns an error message string or a positive coord with the length | QueryCalcNetLen(netname) | query plugin |
QueryCompileField | With "compile": precompiles textual field name to field ID; with "free": frees the memory allocated for a previously precompiled fieldID. | QueryCompileField(compile, fieldname) QueryCompileField(free, fieldID) | query plugin |
QueryObj | Return the value of a field of an object, addressed by the object's idpath and the field's name or precompiled ID. Returns NIL on error. | QueryObj(idpath, [.fieldname|fieldID]) | query plugin |
Quit | Quits the application after confirming. | Quit() | @@ -337,7 +340,7 @@ |
ScriptCookie | Return a cookie specific to the current script instance during script initialization | ScriptCookie() | script plugin |
ScriptPersistency | Read or remove script persistency data savd on preunload | ScriptPersistency(read|remove) | script plugin |
Scroll | Scroll the viewport. | Scroll(up|down|left|right, [pixels]) | lib_hid_common plugin | -
SearchDialog | Open the log dialog. | SearchDialog() | dialogs plugin | +
SearchDialog | Open the log dialog. | SearchDialog() | query plugin |
Select | Toggles or sets the selection. | Select(Object, [idpath]) Select(ToggleObject) Select(All|Block|Connection|Invert) Select(Convert) | |
SelectLayer | Select which layer is the current layer. | SelectLayer(1..MAXLAYER|Silk|Rats) | |
SetFlag | Sets flags on objects. | SetFlag(Object|Selected|SelectedObjects, flag) SetFlag(SelectedLines|SelectedPins|SelectedVias, flag) SetFlag(SelectedPads|SelectedTexts|SelectedNames, flag) SetFlag(SelectedElements, flag) flag = thermal | join | @@ -349,9 +352,6 @@ |
SetUnits | Set the default measurement units. | SetUnits(mm|mil) | |
SetValue | Change various board-wide values and sizes. | SetValue(Grid|Line|LineSize|Text|TextScale, delta) | |
shape | Interactive shape generator. | shape() | shape plugin | -
skline | Tool for drawing sketch lines | skline() | sketch_route plugin | -
skretriangulate | Reconstruct CDT on all layer groups | skretriangulate() | sketch_route plugin | -
sktransform | Transform sketch to geometrical wiring | sktransform(rect|oct|alldir) | sketch_route plugin |
smartdisperse | Disperse subcircuits into clusters, by netlist connections | SmartDisperse([All|Selected]) | smartdisperse plugin |
split | Use one or more objects as cutting edge and trim or split other objects. First argument is the cutting edge | trim([selected|found|object], [selected|found|object]) split([selected|found|object], [selected|found|object]) | ddraft plugin |
StatusSetText | Replace status printout with text temporarily; turn status printout back on if text is not provided. | StatusSetText([text]) | lib_hid_pcbui/status |