api.rlgym

Classes

RLGym

The main RLGym class. This class is responsible for managing the environment and the interactions between

Module Contents

class api.rlgym.RLGym(state_mutator: api.config.StateMutator[api.typing.StateType], obs_builder: api.config.ObsBuilder[api.typing.AgentID, api.typing.ObsType, api.typing.StateType, api.typing.ObsSpaceType], action_parser: api.config.ActionParser[api.typing.AgentID, api.typing.ActionType, api.typing.EngineActionType, api.typing.StateType, api.typing.ActionSpaceType], reward_fn: api.config.RewardFunction[api.typing.AgentID, api.typing.StateType, api.typing.RewardType], transition_engine: api.config.TransitionEngine[api.typing.AgentID, api.typing.StateType, api.typing.EngineActionType], termination_cond: api.config.DoneCondition[api.typing.AgentID, api.typing.StateType] | None = None, truncation_cond: api.config.DoneCondition[api.typing.AgentID, api.typing.StateType] | None = None, shared_info_provider: api.config.SharedInfoProvider[api.typing.AgentID, api.typing.StateType] | None = None, renderer: api.config.Renderer[api.typing.StateType] | None = None)

Bases: Generic[api.typing.AgentID, api.typing.ObsType, api.typing.ActionType, api.typing.EngineActionType, api.typing.RewardType, api.typing.StateType, api.typing.ObsSpaceType, api.typing.ActionSpaceType]

The main RLGym class. This class is responsible for managing the environment and the interactions between the different components of the environment. It is the main interface for the user to interact with an environment.

state_mutator

obs_builder

action_parser

reward_fn

transition_engine

termination_cond = None

truncation_cond = None

renderer = None

shared_info_provider = None

shared_info

property agents: List[api.typing.AgentID]

property action_spaces: Dict[api.typing.AgentID, api.typing.ActionSpaceType]

property observation_spaces: Dict[api.typing.AgentID, api.typing.ObsSpaceType]

property state: api.typing.StateType

action_space(agent: api.typing.AgentID) → api.typing.ActionSpaceType

observation_space(agent: api.typing.AgentID) → api.typing.ObsSpaceType

set_state(desired_state: api.typing.StateType) → Dict[api.typing.AgentID, api.typing.ObsType]

reset() → Dict[api.typing.AgentID, api.typing.ObsType]

step(actions: Dict[api.typing.AgentID, api.typing.ActionType]) → Tuple[Dict[api.typing.AgentID, api.typing.ObsType], Dict[api.typing.AgentID, api.typing.RewardType], Dict[api.typing.AgentID, bool], Dict[api.typing.AgentID, bool]]

render() → Any

close() → None