SimpleEmotes API Guide
======================

Overview:
---------
This guide provides detailed information about the API functions available in the SimpleEmotes project. These methods allow developers to interact with player actions, such as emotes, crouching, crawling, and more.

Methods:
--------

1. **EmoteCommandStart(string emoteName)**
   - **Description**: Starts the specified emote for the player.
   - **Parameters**:
     - `emoteName` (string): The name of the emote to start.
   - **Returns**: Void.
   - **Usage**: 
     - Starts an emote if found, otherwise logs an error.

2. **EmoteCancel(bool forceCancel = false)**
   - **Description**: Cancels the current emote being performed by the player.
   - **Parameters**:
     - `forceCancel` (bool): If true, forces the emote to cancel immediately.
   - **Returns**: Void.
   - **Usage**: 
     - Cancels the emote in progress.

3. **IsPlayerCrouched()**
   - **Description**: Checks if the player is crouched.
   - **Returns**: `bool` - True if crouched, otherwise false.
   - **Usage**: 
     - Use this method to check the player's crouch state.

4. **IsPlayerProne()**
   - **Description**: Checks if the player is prone (lying down).
   - **Returns**: `bool` - True if prone, otherwise false.
   - **Usage**: 
     - Use this method to check if the player is in a prone position.

5. **IsPlayerCrawling()**
   - **Description**: Checks if the player is crawling.
   - **Returns**: `bool` - True if crawling, otherwise false.
   - **Usage**: 
     - Use this method to check if the player is crawling.

6. **IsPlayerPointing()**
   - **Description**: Checks if the player is currently pointing.
   - **Returns**: `bool` - True if pointing, otherwise false.
   - **Usage**: 
     - Use this method to check if the player is pointing.

7. **GetCurrentEmote()**
   - **Description**: Returns the current emote the player is performing, if any.
   - **Returns**: `Emote` - The current emote being performed, or null if none.
   - **Usage**: 
     - Call this method to retrieve the emote the player is currently performing.

8. **ToggleBinoculars()**
   - **Description**: Toggles the use of binoculars by starting a new fiber for binocular functionality.
   - **Returns**: Void.
   - **Usage**: 
     - Starts the binoculars functionality in a new game fiber.

9. **ToggleNewsCam()**
   - **Description**: Toggles the use of the news camera by starting a new fiber for news camera functionality.
   - **Returns**: Void.
   - **Usage**: 
     - Starts the news camera functionality in a new game fiber.

10. **GetCurrentWalkStyle()**
    - **Description**: Placeholder for retrieving the current walk style.
    - **Returns**: Void.
    - **Notes**: 
      - This feature is under development.

11. **SetCurrentWalkStyle()**
    - **Description**: Placeholder for setting the current walk style.
    - **Returns**: Void.
    - **Notes**: 
      - This feature is under development.

General Notes:
--------------
- All methods are marked with `[Obfuscation(Exclude = true)]` to ensure they remain readable for developers.

End of API Guide
================