WM_Rule Update Operator

Quick Facts

Property	Value
Class	`CENPyOlpWM_RuleUpdateOperator`
Module	`cenpylib.CENPyOlpWM_RuleUpdateOperator`
Package	`cenpylib`
Release	R2025.2.4
Methods	5


# Boilerplate Example
wM_RuleUpdateOperator = ...  # obtained from the runtime context
result = wM_RuleUpdateOperator.GetRuleName()

Method	Returns	Summary
`AddEvent`	`—`	Add an event to the rule update operator.
`GetRuleName`	`str`	Get the name of the rule.
`GetActiveEventName`	`str`	Get the name of the currently active event.
`SetActiveEvent`	`—`	Compare all existing event names with the given name and set the first matched event as active.
`OverrideEventRuleInsertPosition`	`—`	Set the new insert position for the event rule.


def GetRuleName() -> str

Get the name of the rule.

Returns: str — Rule name.


def GetActiveEventName() -> str

Get the name of the currently active event.

Returns: str — Active event name.


def AddEvent(eventName: str)

Add an event to the rule update operator.

Parameters:

Name	Type	Description
`eventName`	`str`	Kernel or Python-defined event name.


def SetActiveEvent(eventName: str)

Compare all existing event names with the given name and set the first matched event as active.

Parameters:

Name	Type	Description
`eventName`	`str`	Kernel or Python-defined name of the event to activate.


def OverrideEventRuleInsertPosition(insertPosition: int)

Set the new insert position for the event rule.

Parameters:

Name	Type	Description
`insertPosition`	`int`	New insert position.

This class is documented as of release R2025.2.4.

Was this page helpful?