plupy operations#

plupy · Type index

Every operation the wrapper calls on the editor (call("name", …) in tools/python/plupy). Authoring scripts and the assistant's run_plupy tool use the documented Python members. Each row names that member and the keyword arguments the wrapper sends; target is the handle the member is called on. Generated with the type pages by tools/python/plupy_docs.py.

Operation	Python member	Arguments
`collections.add`	SceneCollection.add	target, use
`collections.list`	SceneCollections	target
`collections.new`	SceneCollections.new	target, name
`collections.objects`	SceneCollection.objects	target
`collections.remove`	SceneCollection.remove	target, use
`collections.set`	SceneCollection.name · SceneCollection.active	target, name, active
`component_props.reset`	ComponentProperties.reset	target, scene, key
`component_props.schema`	ComponentProperties.schema	target, scene
`component_props.set`	ComponentProperties.Assignment	target, scene, key, value
`components.add`	Components.add	target, key, mesh
`components.choices`	Components.choices	target
`components.list`	Components · Components.find	target, key
`components.remove`	Component.remove	target
`context`	Context.area · Context.scene · Context.graph · Context.selected	—
`context.pop`	Context.use	—
`context.push`	Context.use	—
`data.delete`	DataCollection.delete · DataBlock.delete	target
`data.export_glb`	Object.export_glb	target, path
`data.get`	Handle	target
`data.import`	FontCollection.import_file · MeshCollection.import_file · SpriteCollection.import_file · SoundCollection.import_file	type, path, settings
`data.list`	DataCollection	type
`data.new`	DataCollection.new · ShaderCollection.new · ShaderCollection.new_slang · ShapeCollection.new · PhysicsMaterialCollection.new · EffectChainCollection.new · ModulationChainCollection.new · SoundSequenceCollection.new · SoundCollection.new	type, name, surface_model, source, parameters, render_mode, wind, kind, fit, friction, restitution
`data.purge_unused`	Data.purge_unused	—
`data.replace`	Properties.replace	target, values
`data.schema`	Properties.schema	target
`data.set`	Properties.Assignment · DataBlock.name	target, key, value
`data.unused`	Data.unused	—
`effect.element.add`	Effect.add_element	target, model
`effect.element.remove`	Effect.remove_element	target, element
`effect.element.set`	Effect.set_element	target, element, name, value
`effect.elements`	Effect.elements	target
`effects.add`	EffectChain.add	target, kind, values
`effects.list`	EffectChain.effects	target
`effects.move`	EffectChain.move	target, effect, index
`effects.remove`	EffectChain.remove	target, effect
`effects.set`	EffectChain.set	target, effect, name, value
`evaluated.active`	EvaluatedUse.active	target
`evaluated.schema`	EvaluatedProperties.schema	target
`inputs.connect`	Inputs.connect	target, name, pin
`inputs.disconnect`	Inputs.disconnect	target, name, pin
`inputs.get`	EvaluatedInputs.Indexing · Inputs.Indexing	target, name, evaluated
`inputs.list`	EvaluatedInputs.Iteration · EvaluatedInputs.Length · Inputs.Iteration · Inputs.Length	target, evaluated
`inputs.remove`	Inputs.remove	target, name
`inputs.reset`	Inputs.reset	target, name
`inputs.set`	Inputs.Assignment	target, name, value
`library.add`	LibraryFolder.new · LibraryFolder.add	target, path, name, object
`library.list`	LibraryFolder	target
`library.remove`	LibraryFolder.remove	target, path, object
`mesh.model.check`	Mesh.check_model	target, path
`mesh.model.set`	Mesh.replace_model	target, path, force
`modulation.add`	ModulationChain.add	target, kind, on, values
`modulation.list`	ModulationChain.modulators	target
`modulation.remove`	ModulationChain.remove	target, modulator
`modulation.set`	ModulationChain.set	target, modulator, name, value
`ops.bake_navigation`	Ops.bake_navigation	scene
`ops.bake_wire`	ObjectOps.bake_wire	start, end, start_normal, end_normal, slack, radius, sides, align_ends, material, name, scene
`ops.connect_scene_tunnel`	Ops.connect_scene_tunnel	entry, exit, scene, name, width, height
`ops.drop_to_floor`	ObjectOps.drop_to_floor	targets, align, max_distance
`ops.move`	ObjectOps.move · ObjectOps.move_2d	delta, space, targets, two_d
`ops.settle`	ObjectOps.settle	targets, seconds
`pins.expose`	Pin.expose	target, name
`pins.get`	Pin.value	target
`pins.list`	Pins.schema	target
`pins.set`	Pin.value	target, value
`project.cursor.set`	Ops.set_cursor_mode	mode
`scene.bounds`	Use.bounds	target
`scene.find_path`	Scene.find_path	scene, start, destination
`scene.raycast`	Scene.raycast	scene, origin, direction, max_distance, ignore
`scene.tunnel_exits`	Ops.scene_tunnel_exits	entry
`scripts.attach`	Scripts.attach	target, name
`scripts.new`	Scripts.new	name, folder
`selection`	Context.select	targets
`sequence.import`	SoundSequenceCollection.import_midi	path, name, programs, drums, soundfont, rows_per_beat, pattern_rows
`sequence.text`	SoundSequence.to_text	target
`sequence.text.set`	SoundSequence.from_text	target, text
`sequence.trackEffects`	SoundSequence.set_track_effects	target, track, chain
`shader.code.set`	Shader.set_code	target, source, parameters, surface_model, render_mode, wind
`shader.describe`	Shader.surface_model · Shader.render_mode · Shader.source · Shader.parameters	target
`sound.soundfont`	SoundCollection.import_soundfont	path, presets
`transform.get`	Transform	channel
`transform.set`	Transform	channel, value
`uses.add`	Uses.add	target, object, name
`uses.duplicate`	Use.duplicate	target, unique
`uses.list`	Uses	target, roots
`uses.local_reference`	Use.local_reference	target, root
`uses.remove`	Use.remove	target
`uses.set`	Use.name · Use.active	target, name, active
`uses.unique`	Use.make_unique	target
`zones.add`	Sound.add_zone	target, sample, low, high, pitch, root, values
`zones.list`	Sound.zones	target
`zones.remove`	Sound.remove_zone	target, zone
`zones.set`	Sound.set_zone	target, zone, name, value