πŸ“¦ JEMouseCodeGroup

Technical reference for the JEMouseCodeGroup class of JarEngine.

Inherit from β€’>JEInternBaseClass<β€’πŸ“Ž


πŸ”Ή Overview

JEMouseCodeGroup is responsible for grouping multiple mouse codes into a single mouse input collection.

Provides:

  • Storage of multiple JEMouseCode objects.
  • Mouse group combination through operator overloading.
  • Iteration support over stored mouse codes.

Represents a collection of mouse identifiers used by JarEngine’s input system. It allows multiple mouse buttons to be handled together, simplifying input comparisons while keeping compatibility with individual JEMouseCode objects.


πŸ”Ή Location

JarEngine
β”‚
β”œβ”€β”€ events
β”‚     └── JEMouseCodeGroup
β”‚
└── ...

πŸ”Ή Data

Field Type Description Property? Can be set?
mouses list[JEMouseCode] Stored mouse codes contained in the group. True False

πŸ”Ή API

Function Arguments Returns Description
__init__ mouses: list[JEMouseCode] Β  Creates a mouse group from a list of mouse codes.
__or__ other: JEMouseCode \| JEMouseCodeGroup JEMouseCodeGroup Creates a new mouse group by combining existing mouse codes with another mouse or group.
__iter__ Β  Iterator[JEMouseCode] Returns an iterator over the stored mouse codes.

πŸ”Ή Usage

from jarengine import Events

left_click = Events.Mouse.JEMouseCode(1)
right_click = Events.Mouse.JEMouseCode(3)

mouse_group = left_click | right_click

for mouse in mouse_group:
    print(int(mouse))