VortexDocs
  • Vortex Engine
    • Installation
      • 1. Install Python
      • 2. Install VortexEngine
      • 3. Install Additional Dependencies
    • Getting Started
      • 1. Initialize Vortex
      • 2. Create Game Objects
      • 3. Add Labels
      • 4. Add a First Person Controller
      • 5. Run the Game
    • API Reference
      • 1. Vortex Class
      • 2. Tool Module
      • 3. Data Module
    • Example
      • 1. Basic Example
      • 2. API Integration Example
    • Troubleshooting
      • 1. ModuleNotFoundError
        • 1. Verify Installation:
        • 2. Check Python Environment:
        • 3. Verify Import Statement:
      • 2. Color Not Recognized
        • 1. Check Color Input:
        • 2. Refer to color_dict:
        • 3. Update Color Usage:
        • 4. Verify Code:
    • Additional Resources
  • Vortex Breakout
Powered by GitBook
On this page
  1. Vortex Engine
  2. API Reference

1. Vortex Class

The Vortex class provides methods and attributes to interact with the VortexEngine for creating and managing game objects and scenes.

1 __init__(PrivateKey="", Address="", Chain="Aptos", ApiKey=False, **kwargs)

Initializes a Vortex instance.

  • PrivateKey (str): Your private key for authentication. Default is an empty string.

  • Address (str): Your address for interaction. Default is an empty string.

  • Chain (str): The blockchain chain to use. Default is "Aptos".

  • ApiKey (bool): If set to True, it will fetch data using the provided API key.

  • **kwargs: Additional keyword arguments for customization.

2 Object(**kwargs)

Creates and returns a new game object with the specified parameters. Adds the object to the list of temporary objects.

  • Parameters:

    • **kwargs: Parameters such as model, color, scale, etc., to define the game object.

3 Label(**kwargs)

Creates and returns a new text label. Adds the label to the list of temporary objects.

  • Parameters:

    • **kwargs: Parameters such as text and position to define the label.

4 firstPersonController(**kwargs)

Creates and returns a first-person controller. Adds the controller to the list of temporary objects.

  • Parameters:

    • **kwargs: Parameters for customizing the first-person controller.

5 color(color_input)

Converts the input into a color object. Supports color names, hex values, and RGB tuples.

  • Parameters:

    • color_input (str or tuple): The input color in the form of a name, hex value, or RGB tuple.

6 UpdateBlock()

Updates the global output JSON with the current state of objects and colors.

  • Returns:

    • None

7 run()

Starts the Vortex application. Handles application shutdown and updates the output JSON.

  • Returns:

    • None

PreviousAPI ReferenceNext2. Tool Module

Last updated 9 months ago