Model.hm_isentitysupportedforaction#

Model.hm_isentitysupportedforaction(entity_type, action)#

Determines if a particular entity type is supported for a certain action. A return value of 0 means it is not supported. A return value of 1 means it is supported.

Parameters:

entity_type (EntityFullType) – The type of entity to query.
action (hwString) – The action to query. Currently supported actions are CARDEDIT, CREATE, REVIEW, and SHIIR.

Returns:

hwReturnStatus - Status object
HmQueryResult - Result object containing the output values:
- isSupported (bool)

Examples#

Query if components are supported for CARDEDIT#

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_isentitysupportedforaction(entity_type=ent.Component, action="CARDEDIT")

print("isSupported", result.isSupported)

Query if nodes are supported for SHIIR#

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_isentitysupportedforaction(entity_type=ent.Node, action="SHIIR")

print("isSupported", result.isSupported)