Go to: Synopsis. Return value. Related. Flags. Python examples.

Synopsis

effector( [object] , [hide=boolean], [name=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

effector is undoable, queryable, and editable.

The effector command is used to set the name or hidden flag for the effector. The standard edit (-e) and query (-q) flags are used for edit and query functions.

Return value

string

In query mode, return type is based on queried flag.

Related

ikHandle, ikSolver, ikSystem

Flags

hide, name
Long name (short name) Argument types Properties
name(n) string createqueryedit
Specifies the name of the effector.
hide(hi) boolean createqueryedit
Specifies whether to hide drawing of effector if attached to a handle.

Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Will cause effector1 not to be displayed if attached to a handle.
# This is the default.
#
cmds.effector( 'effector1', e=True, hi=False )

# Will cause effector1 to be displayed if attached to a handle.
#
cmds.effector( 'effector1', e=True, hi=True )