SelectFlag
SelectFlag

Selects objects based on the value of one of their flags

bSuccess = myClass.SelectFlag( Index, bON, Operation, bAny )
bSuccess = myClass.SelectFlag( Index, bON, Operation )
bSuccess = myClass.SelectFlag( Index, bON )

Return value
TRUE if the selection was successful, otherwise FALSE.

Parameters
  • Index
    The index of the flag to check
  • bON
    The value to filter for
  • Operation
    The comparison operation to use, one of:
    • EQUAL
      Value must be equal to the given value
    • GREATER
      Value must be greater than the given value
    • LOWER
      Value must be lower than the given value
    • GREATEREQUAL
      Value must be greater than or equal to the given value
    • LOWEREQUAL
      Value must be lower than or equal to the given value
    • DIFFERENT
      Value must be different to the given value
  • bAny
    TRUE (default) to allow any object to be selected. FALSE to only allow objects which are already selected (de-selects objects which do not match the criteria)
See also
Class:SetFlag
Class:GetFlag


JAM © 2005 no one in particular
Project started by David Evans in 2005