Cut the Rope: DX

https://github.com/yell0wsuit/ctrdx-docs
Admin
Cut the Rope: DX is a puzzle game with comprehensive codebase documentation covering game...
Tokens:374,106
Snippets:4,186
Trust Score:9
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start() Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/IVideoPlayer.md

Starts video playback.

```APIDOC
## POST /IVideoPlayer/Start

### Description
Starts video playback after a video has been prepared with `Play`.

### Method
POST

### Endpoint
/IVideoPlayer/Start
```

--------------------------------

### Start()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/VideoPlayerFFmpeg.md

Starts video playback after a video has been prepared.

```APIDOC
## Start()

### Description
Starts video playback after a video has been prepared with [Play](IVideoPlayer.md#m-cuttheropedx-framework-media-ivideoplayer-play-system-string-system-boolean).

### Method
POST

### Endpoint
/api/videoplayer/ffmpeg/start
```

--------------------------------

### Create and Configure BaseElement

Source: https://context7.com/yell0wsuit/ctrdx-docs/llms.txt

Provides an example of creating a BaseElement and setting its basic properties like position, size, visibility, and touchability. Use this as a starting point for any visual component.

```csharp
// Create and configure a base element
var element = new BaseElement();
element.x = 100;
element.y = 200;
element.width = 150;
element.height = 100;
element.visible = true;
element.touchable = true;
element.updateable = true;
```

--------------------------------

### Start particle system

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GhostMorphingCloud.md

Starts the particle system using default particle count.

```csharp
public void StartSystem()
```

--------------------------------

### LevelFirstStart()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Starts the first-level open transition and enables gameplay input.

```csharp
public void LevelFirstStart()
```

--------------------------------

### Setup Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Helpers/RPCHelpers.md

Initiates the Discord IPC connection on a background thread.

```csharp
public void Setup()
```

--------------------------------

### LevelFirstStart

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Starts the first-level open transition and enables gameplay input.

```APIDOC
## LevelFirstStart

### Description
Starts the first-level open transition and enables gameplay input.

### Method
POST

### Endpoint
/api/gamecontroller/levelfirststart
```

--------------------------------

### LevelStart()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Starts a normal level open transition and enables gameplay input.

```csharp
public void LevelStart()
```

--------------------------------

### InitGameView()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Initializes the game view for a fresh level start.

```csharp
public void InitGameView()
```

--------------------------------

### LevelStart

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Starts a normal level open transition and enables gameplay input.

```APIDOC
## LevelStart

### Description
Starts a normal level open transition and enables gameplay input.

### Method
POST

### Endpoint
/api/gamecontroller/levelstart
```

--------------------------------

### Start movement

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Helpers/Mover.md

Initiates movement from the first path point.

```csharp
public virtual void Start()
```

--------------------------------

### InitGameView

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Initializes the game view for a fresh level start.

```APIDOC
## InitGameView

### Description
Initializes the game view for a fresh level start.

### Method
POST

### Endpoint
/api/gamecontroller/initgameview
```

--------------------------------

### Initialize CTRApp Application

Source: https://context7.com/yell0wsuit/ctrdx-docs/llms.txt

Use this to create and launch the main application instance. Call `ApplicationDidFinishLaunching` to start the game.

```csharp
public class GameEntry
{
    public static void Main(string[] args)
    {
        var app = new CTRApp();
        app.ApplicationDidFinishLaunching();
    }
}
```

--------------------------------

### Define waitForStart flag

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/VideoPlayerFFmpeg.md

Indicates the player is waiting for Start() to be called.

```csharp
private bool waitForStart
```

--------------------------------

### EnableNightMode Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Star.md

Prepares the night-mode visual setup; must be called before CreateAnimations.

```csharp
public void EnableNightMode()
```

--------------------------------

### Get Integer Preference

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/Preferences.md

Gets an integer preference. Returns 0 if not found.

```csharp
public static int GetIntForKey(string key)
```

--------------------------------

### Get Boolean Preference

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/Preferences.md

Gets a boolean preference. Returns `false` if not found.

```csharp
public static bool GetBooleanForKey(string key)
```

--------------------------------

### Initialize Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/ITargetAnimationBackend.md

Sets up the backend's timeline state and delegates. Requires a timeline delegate for keyframe callbacks.

```csharp
public abstract void Initialize(ITimelineDelegate timelineDelegate)
```

--------------------------------

### Get String Preference

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/Preferences.md

Gets a string preference. Returns empty string if not found.

```csharp
public static string GetStringForKey(string key)
```

--------------------------------

### Initialize Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Game1.md

Initializes game components and loads non-graphical resources.

```csharp
protected override void Initialize()
```

--------------------------------

### Initialize C#

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/FlashXmlTargetAnimationBackend.md

Sets up the animation backend and binds the provided timeline delegate.

```csharp
public void Initialize(ITimelineDelegate timelineDelegate)
```

--------------------------------

### Get or set TransporterScale property

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Bouncer.md

Gets or sets the current scale factor applied by the transporter.

```csharp
public float TransporterScale { get; set; }
```

--------------------------------

### Initialize path from string

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Helpers/Mover.md

Constructs a path from a serialized string and a starting position.

```csharp
public virtual void SetPathFromStringandStart(string p, Vector s)
```

--------------------------------

### ChallengeStartedWithGameConfig Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Commons/CTRApp.md

Starts a challenge session using the provided game configuration payload.

```APIDOC
## Method ChallengeStartedWithGameConfig(string gameConfig)

### Description
Starts a challenge session using the provided game configuration payload.

### Method
`public void ChallengeStartedWithGameConfig(string gameConfig)`

### Parameters
#### Path Parameters
- **gameConfig** (string) - Required - The serialized game configuration for the challenge.
```

--------------------------------

### Get Shared SpriteBatch

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Desktop/Renderer.md

Gets the shared SpriteBatch instance, which is used for rendering text and sprites.

```csharp
public static SpriteBatch GetSpriteBatch()
```

--------------------------------

### SetupWithStartPointEndPointSpeed

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/AntsPathSegment.md

Initializes segment fields.

```APIDOC
## SetupWithStartPointEndPointSpeed(Vector start, Vector end, float speedMagnitude, float deviceScale)

### Description
(Re)initialises all derived fields from the given endpoints, speed magnitude and device scale.

### Parameters
- **start** (Vector) - Required - World-space start point.
- **end** (Vector) - Required - World-space end point.
- **speedMagnitude** (float) - Required - Speed in world units per second.
- **deviceScale** (float) - Required - Device pixel-density multiplier.
```

--------------------------------

### One-Time OpenGL Preparation

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Platform/GLCanvas.md

Performs one-time setup operations for OpenGL. This method is a no-op and retained for backward compatibility.

```csharp
public static void PrepareOpenGL()
```

--------------------------------

### Get Mouse Has Candy Status

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Mouse.md

Gets a boolean value indicating if the mouse is currently carrying candy.

```csharp
public bool HasCandy { get; }
```

--------------------------------

### PlayTimeline Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/Timeline.md

Starts or resumes the timeline playback. If paused, it resumes from the current position; otherwise, it starts from the beginning.

```csharp
public void PlayTimeline()
```

--------------------------------

### Init

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Desktop/ScreenSizeManager.md

Initializes screen sizing from the current display mode, preferred window width, and fullscreen state.

```csharp
public void Init(DisplayMode displayMode, int windowWidth, bool isFullScreen)
```

--------------------------------

### Start video playback

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/VideoPlayerFFmpeg.md

Initiates playback for a video previously prepared via Play.

```csharp
public void Start()
```

--------------------------------

### Get Mouse Active Status

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Mouse.md

Gets or sets a boolean value indicating if the mouse is currently active and can interact.

```csharp
public bool IsActive { get; private set; }
```

--------------------------------

### StartupController Methods

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/StartupController.md

API methods for managing the startup lifecycle, resource loading, and event handling.

```APIDOC
## Activate()

### Description
Activates the controller and notifies the root controller.

## AllResourcesLoaded()

### Description
Marks startup resource loading as complete.

## MoviePlaybackFinished(string url)

### Description
Starts resource loading after startup movie playback has finished.

### Parameters
- **url** (string) - Required - Movie URL reported by the movie manager, or null when loading starts directly.

## TimelineFinished(Timeline t)

### Description
Called when the timeline finishes playback.

### Parameters
- **t** (Timeline) - Required - Timeline that finished.

## TimelinereachedKeyFramewithIndex(Timeline t, KeyFrame k, int i)

### Description
Called when the timeline reaches keyframe k at index i.

### Parameters
- **t** (Timeline) - Required - Timeline that reached the keyframe.
- **k** (KeyFrame) - Required - Keyframe that was reached.
- **i** (int) - Required - Index of the keyframe.

## TouchesBeganwithEvent(IList<TouchLocation> touches)

### Description
Forwards the first pressed touch in the collection to the active view.

### Parameters
- **touches** (IList<TouchLocation>) - Required - Touch collection to inspect.

### Response
- **bool** - Returns true if the active view handled the touch; otherwise false.

## Update(float t)

### Description
Updates the active view, if one is currently shown.

### Parameters
- **t** (float) - Required - Time delta.
```

--------------------------------

### Get animation by resource name

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CharAnimations.md

Gets the base animation or a named child animation by texture resource name.

```csharp
public Animation GetAnimation(string resourceName)
```

--------------------------------

### Initialize Audio Components

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/VideoPlayerFFmpeg.md

Sets up the necessary components for audio decoding and playback. Returns true if successful or if no audio stream is present.

```csharp
private bool InitializeAudio()
```

--------------------------------

### Initialize VideoPlayerFFmpeg

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/VideoPlayerFFmpeg.md

Constructors for creating a new instance of the video player, including a version for custom dependency injection.

```csharp
public VideoPlayerFFmpeg()
```

```csharp
internal VideoPlayerFFmpeg(Func<string, bool> fileExists, Func<string, string> resolveRootPath)
```

--------------------------------

### Get Box Boolean Preference

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/Preferences.md

Gets a boolean preference for a specific `box` slot. Returns `false` if missing.

```csharp
public static bool GetBoxBoolForKey(int box, string key)
```

--------------------------------

### Get Ribbon Color

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/FingerTraces/RibbonFingerTrace.md

Gets the ribbon color for a normalized position along the strip. The position `t` should be in the range [0, 1].

```csharp
protected abstract RGBAColor GetRibbonColor(float t)
```

--------------------------------

### Get or set PositionOnTransporter property

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Bouncer.md

Gets or sets the normalized position along the transporter path, ranging from 0 to 1.

```csharp
public float PositionOnTransporter { get; set; }
```

--------------------------------

### Custom Application Setup

Source: https://context7.com/yell0wsuit/ctrdx-docs/llms.txt

Extend the base `Application` class to override factory methods for custom configuration, such as screen dimensions or sound manager implementation.

```csharp
public class CustomApp : Application
{
    public override ApplicationSettings CreateAppSettings()
    {
        var settings = new ApplicationSettings();
        settings.ScreenWidth = 1920;
        settings.ScreenHeight = 1080;
        return settings;
    }

    public override SoundMgr CreateSoundMgr()
    {
        return new SoundMgr();
    }
}
```

--------------------------------

### Get Box String Preference

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/Preferences.md

Gets a string preference for a specific `box` slot. Returns an empty string if missing.

```csharp
public static string GetBoxStringForKey(int box, string key)
```

--------------------------------

### Initialize()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Game1.md

Initializes the game and loads non-graphical resources.

```APIDOC
## POST /game/initialize

### Description
Initializes the game and loads any needed non-graphical resources. Initializes attached GameComponent instances and calls LoadContent.

### Method
POST

### Endpoint
/game/initialize

### Response
#### Success Response (200)
- **status** (string) - Indicates the initialization was successful.

### Response Example
```json
{
  "status": "initialized"
}
```
```

--------------------------------

### Get Box Integer Preference

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/Preferences.md

Gets an integer preference for a specific `box` slot. Returns 0 if missing or invalid.

```csharp
public static int GetBoxIntForKey(int box, string key)
```

--------------------------------

### StartLoading

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/ResourceMgr.md

Initiates the incremental loading process.

```APIDOC
## StartLoading

### Description
Starts timer-driven incremental loading when a resource delegate is available.
```

--------------------------------

### Start Splash Animation

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/StartupController.md

Builds and starts the Flash XML splash animation once loading has completed. This method is called after resources are loaded.

```csharp
private void StartSplashAnimation()
```

--------------------------------

### SetPathFromStringandStart

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CTRMover.md

Builds a movement path from a serialized string and sets the starting position.

```APIDOC
## SetPathFromStringandStart(string p, Vector s)

### Description
Builds a path from a serialized string and prepends the supplied start point. Supports circular path syntax starting with 'R'.

### Parameters
- **p** (string) - Required - Serialized path description.
- **s** (Vector) - Required - Starting position for the generated path.
```

--------------------------------

### Tutorial and Scene Management

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameScene.md

Utility methods for managing tutorial elements and scene state.

```APIDOC
## ShouldSkipTutorialElement

### Description
Determines whether a tutorial element should be skipped for the active language.

### Parameters
- **c** (XElement) - Required - The tutorial XML element to inspect.

### Response
- **returns** (bool) - true when the element does not match the active locale; otherwise, false.

## ShowGreeting

### Description
Plays the active Om Nom greeting animation and matching sounds.

## XmlLoaderFinishedWithfromwithSuccess

### Description
Handles completion of XML loading for the current map and restarts the scene state.

### Parameters
- **rootNode** (XElement) - Required - The loaded XML root node.
- **_** (string) - Required - The XML loader source identifier.
- **_1** (bool) - Required - The XML loader success flag.
```

--------------------------------

### Get Language Selection Index

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/MenuButtonId.md

Gets the zero-based index for a language selection button. Returns -1 if the identifier is not for a language selection button.

```csharp
public int GetLanguageSelectIndex()
```

--------------------------------

### Get Stars Required to Unlock Pack

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CTRPreferences.md

Gets the number of stars required to unlock the specified pack. Parameter: n - The pack index.

```csharp
public static int PackUnlockStars(int n)
```

--------------------------------

### StartCamera() - Initialize Camera

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameScene.md

Positions the camera for the newly loaded map and sets the initial camera movement mode. No parameters are required.

```csharp
public void StartCamera()
```

--------------------------------

### Declare Light Start Coordinate

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Bungee.md

Declares an integer for the starting coordinate index for Christmas light placement within a segment. This helps in managing the distribution of lights.

```csharp
private static int s_lightStartCoord
```

--------------------------------

### Initialize VBox

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/VBox.md

Sets up the vertical box with specific spacing, alignment, and width parameters.

```csharp
public VBox InitWithOffsetAlignWidth(float of, int a, float w)
```

--------------------------------

### Start Challenge Session

Source: https://context7.com/yell0wsuit/ctrdx-docs/llms.txt

Initiate a game challenge session by providing game configuration as a JSON string. This sets up the initial game state.

```csharp
var app = new CTRApp();
app.ChallengeStartedWithGameConfig("{\"level\": 1, \"box\": 0}");
```

--------------------------------

### Get Current Height Modulated

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/SteamTube.md

Gets the current steam height with sine wave modulation for a pulsing effect. Returns the modulated steam height in world units.

```csharp
public float GetCurrentHeightModulated()
```

--------------------------------

### Get Level Count in Pack (with Shareware Limit)

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CTRPreferences.md

Gets the number of levels within a specified pack, applying shareware restrictions if applicable. Returns the number of levels.

```csharp
public static int GetLevelsInPackCount(int pack)
```

--------------------------------

### Prepare video for playback

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/VideoPlayerFFmpeg.md

Initializes a video from a relative path with an optional mute setting.

```csharp
public void Play(string moviePath, bool mute)
```

--------------------------------

### LevelLost

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Starts the level-lost box transition.

```APIDOC
## LevelLost

### Description
Starts the level-lost box transition.

### Method
POST

### Endpoint
/api/gamecontroller/levellost
```

--------------------------------

### LevelLost()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Starts the level-lost box transition.

```csharp
public void LevelLost()
```

--------------------------------

### Configure RootController Transitions

Source: https://context7.com/yell0wsuit/ctrdx-docs/llms.txt

Illustrates setting up screen transition effects for the root controller. Use this to define how screens change, e.g., fade or slide.

```csharp
// Set up root controller with transitions
var rootController = Application.SharedRootController();

// Configure transition effect
rootController.SetViewTransition(RootController.TRANSITION_FADE_OUT_BLACK);
// Available transitions:
// TRANSITION_FADE_OUT_BLACK, TRANSITION_FADE_OUT_WHITE
// TRANSITION_SLIDE_HORIZONTAL_LEFT, TRANSITION_SLIDE_HORIZONTAL_RIGHT
// TRANSITION_SLIDE_VERTICAL_UP, TRANSITION_SLIDE_VERTICAL_DON
// TRANSITION_REVEAL

// Check if transition is active
if (!rootController.IsTransitionActive())
{
    // Safe to switch controllers
}
```

--------------------------------

### GetMusicPath

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Helpers/ContentPaths.md

Gets the path to a music file.

```APIDOC
## GetMusicPath

### Description
Gets the path to a music file.

### Method
N/A (This is a helper function, not an API endpoint)

### Parameters
#### Path Parameters
- **fileName** (string) - Required - The music filename

### Response
#### Success Response
- **string** - The relative path to the music file (e.g., "sounds/menu_music")
```

--------------------------------

### Initialize

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/OriginalTargetAnimationBackend.md

Initializes backend timeline state and delegates.

```APIDOC
## Initialize(ITimelineDelegate timelineDelegate)

### Description
Initializes backend timeline state and delegates.

### Method
public void

### Parameters
#### Path Parameters
- **timelineDelegate** (ITimelineDelegate) - Required - Timeline delegate receiving keyframe callbacks.
```

--------------------------------

### GetMapPath

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Helpers/ContentPaths.md

Gets the path to a level file.

```APIDOC
## GetMapPath

### Description
Gets the path to a level file.

### Method
N/A (This is a helper function, not an API endpoint)

### Parameters
#### Path Parameters
- **mapFileName** (string) - Required - The level filename (e.g., "1_1.xml")

### Response
#### Success Response
- **string** - The full path to the level file
```

--------------------------------

### PlayTimeline Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Processing.md

Starts playback of a specific timeline.

```APIDOC
## POST /api/processing/timeline/play

### Description

Starts playback of the timeline at the specified slot ID, stopping any currently active timeline.

### Method

POST

### Endpoint

`/api/processing/timeline/play`

### Parameters

#### Request Body

- **t** (integer) - Required - Slot ID of the timeline to play.

### Request Example

```json
{
  "t": 1
}
```

### Response

#### Success Response (200)

(No specific response body defined for success, typically indicates operation completion)

### Response Example

```json
{
  "status": "success"
}
```
```

--------------------------------

### Initialize particle system

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/LeafParticles.md

Sets up the particle system with count, angle, texture atlas, and optional gravity bias.

```csharp
public LeafParticles Init(int totalParticles, float angle, Image grid, float bgx = 0)
```

--------------------------------

### GetVideoPath

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Helpers/ContentPaths.md

Gets the path to an HD video file.

```APIDOC
## GetVideoPath

### Description
Gets the path to an HD video file.

### Method
N/A (This is a helper function, not an API endpoint)

### Parameters
#### Path Parameters
- **fileName** (string) - Required - The video filename without extension

### Response
#### Success Response
- **string** - The relative path to the video file
```

--------------------------------

### Initialize and Queue Resources for Loading

Source: https://context7.com/yell0wsuit/ctrdx-docs/llms.txt

Prepare the resource manager by initializing it and adding desired assets to the loading queue. This is the first step before starting the loading process.

```csharp
var resourceMgr = Application.SharedResourceMgr();
resourceMgr.InitLoading();
resourceMgr.AddResourceToLoadQueue("gameplay_background");
resourceMgr.AddResourceToLoadQueue("character_sprites");
resourceMgr.AddResourceToLoadQueue("ui_buttons");
```

--------------------------------

### GetSoundEffectPath

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Helpers/ContentPaths.md

Gets the path to a sound effect file.

```APIDOC
## GetSoundEffectPath

### Description
Gets the path to a sound effect file.

### Method
N/A (This is a helper function, not an API endpoint)

### Parameters
#### Path Parameters
- **fileName** (string) - Required - The sound effect filename

### Response
#### Success Response
- **string** - The relative path to the sound effect file (e.g., "sounds/sfx/tap")
```

--------------------------------

### InitializeBelt

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/ConveyorBelt.md

Configures the belt with the specified parameters and rebuilds its visuals.

```APIDOC
## InitializeBelt

### Description
Configures the belt with the specified parameters and rebuilds its visuals.

### Method
`public void InitializeBelt(int id, float x, float y, float length, float height, float rotation, bool isManual, float velocity)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **id** (int) - Required - Unique identifier for this belt.
- **x** (float) - Required - The x-coordinate of the belt's left edge origin.
- **y** (float) - Required - The y-coordinate of the belt's left edge origin.
- **length** (float) - Required - The length of the belt along its direction.
- **height** (float) - Required - The height (thickness) of the belt.
- **rotation** (float) - Required - The rotation angle in degrees.
- **isManual** (bool) - Required - If `true`, the belt is controlled by user drag; otherwise it moves automatically.
- **velocity** (float) - Required - The automatic movement speed (used only when not manual).

### Request Example
```json
{
  "id": 1,
  "x": 0.0,
  "y": 0.0,
  "length": 10.0,
  "height": 1.0,
  "rotation": 0.0,
  "isManual": false,
  "velocity": 5.0
}
```

### Response
#### Success Response (200)
None (void method)

#### Response Example
None
```

--------------------------------

### Initialize CTRPreferences

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CTRPreferences.md

Initializes game preferences. This constructor handles first-launch setup and migration from older versions.

```csharp
public CTRPreferences()
```

--------------------------------

### CreateAbout Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/AboutView.md

Creates and returns the About/Credits MenuView, attaching it to a specified background element. Uses an IButtonDelegation for the back button.

```csharp
public MenuView CreateAbout(BaseElement background, IButtonDelegation buttonDelegate)
```

--------------------------------

### Rotate

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/MechanicalHandSegment.md

Starts a 90-degree rotation animation when the segment can rotate.

```APIDOC
## Rotate

### Description
Starts a 90-degree rotation animation when the segment can rotate. Queues one extra rotation if tapped again during cooldown.
```

--------------------------------

### StartLoading Resource Initialization

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/ResourceMgr.md

Initiates timer-driven incremental loading if a resource delegate is assigned.

```csharp
public virtual void StartLoading()
```

--------------------------------

### PlayFireBounceTimeline

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Lantern.md

Dispatcher callback that starts the fire bounce animation.

```csharp
private void PlayFireBounceTimeline(FrameworkTypes _)
```

--------------------------------

### Initialize FFmpeg and Open File

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/VideoPlayerFFmpeg.md

Initializes FFmpeg contexts and opens the specified video file for decoding. Returns true on success.

```csharp
private bool InitializeFfmpeg(string filePath)
```

--------------------------------

### Initialize GhostMorphingCloud

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GhostMorphingCloud.md

Initializes the particle system with texture and default emission settings.

```csharp
public GhostMorphingCloud Init()
```

--------------------------------

### Initialize Mouse Parameters

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Mouse.md

Sets up the mouse's initial position, appearance, and behavior parameters, including grab radius and maximum duration.

```csharp
public void Initialize(float px, float py, float angle, float radius, float duration)
```

--------------------------------

### GetStringsPath

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Helpers/ContentPaths.md

Gets the path to a per-language localization JSON file.

```APIDOC
## GetStringsPath

### Description
Gets the path to a per-language localization JSON file.

### Method
N/A (This is a helper function, not an API endpoint)

### Parameters
#### Path Parameters
- **languageCode** (string) - Required - The language code (e.g., "en", "ru")

### Response
#### Success Response
- **string** - The relative path (e.g., "strings/en.json")
```

--------------------------------

### Initialize StartupController

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/StartupController.md

Constructor for initializing the startup controller with a parent view controller.

```csharp
public StartupController(ViewController parent)
```

--------------------------------

### Get PackName

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/PackDefinition.md

Retrieves the localized name of the box pack.

```csharp
public string PackName { get; }
```

--------------------------------

### GetAllLanterns

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Lantern.md

Gets the shared list of lanterns in the current level.

```csharp
public static List<Lantern> GetAllLanterns()
```

--------------------------------

### ChallengeStartedWithGameConfig Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Commons/CTRApp.md

Starts a challenge session using the provided game configuration payload. The game configuration is passed as a serialized string.

```csharp
public void ChallengeStartedWithGameConfig(string gameConfig)
```

--------------------------------

### Initialize ConstraintSystem

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Physics/ConstraintSystem.md

Constructor for creating an empty constraint system instance.

```csharp
public ConstraintSystem()
```

--------------------------------

### Access Value Property

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/FlashXmlFloat1KeyFrame.md

Gets or sets the keyframe value.

```csharp
public float Value { get; set; }
```

--------------------------------

### PlayInnerCandyIdleTimeline

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Lantern.md

Dispatcher callback that starts the inner candy idle animation.

```csharp
private void PlayInnerCandyIdleTimeline(FrameworkTypes _)
```

--------------------------------

### InitWithTexture Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Helpers/GameObject.md

Initializes the image with a texture, setting the first quad or the full image. Returns the image instance for chaining.

```csharp
public override Image InitWithTexture(CTRTexture2D texture)
```

--------------------------------

### LevelQuit

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Starts the level quit transition and disables gameplay input.

```APIDOC
## LevelQuit

### Description
Starts the level quit transition and disables gameplay input.

### Method
POST

### Endpoint
/api/gamecontroller/levelquit
```

--------------------------------

### CreateMainMenu

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/MenuController.md

Builds the main menu view.

```csharp
public void CreateMainMenu()
```

--------------------------------

### WarmOmNomGridIncrementally

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CandySelectionView.md

Initializes a batch of Om Nom grid slots after background preparation.

```csharp
private static void WarmOmNomGridIncrementally()
```

--------------------------------

### LevelQuit()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Starts the level quit transition and disables gameplay input.

```csharp
public void LevelQuit()
```

--------------------------------

### Play() Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/IVideoPlayer.md

Prepares a video for playback.

```APIDOC
## POST /IVideoPlayer/Play

### Description
Prepares a video for playback from the specified path.

### Method
POST

### Endpoint
/IVideoPlayer/Play

### Parameters
#### Request Body
- **moviePath** (string) - Required - The relative path to the video file without extension.
- **mute** (bool) - Required - If `true`, audio will be muted during playback.

### Request Example
```json
{
  "moviePath": "path/to/video",
  "mute": false
}
```
```

--------------------------------

### UpdateRange

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/Track.md

Recalculates the start and end times for a track based on its keyframes.

```APIDOC
## UpdateRange

### Description
Recalculates startTime and endTime from the keyframes.
```

--------------------------------

### UpdateRange

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/Track.md

Recalculates the start and end times based on the current keyframes.

```csharp
public void UpdateRange()
```

--------------------------------

### Initialize View

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/View.md

Constructor for creating a view instance sized to current logical screen dimensions.

```csharp
public View()
```

--------------------------------

### CreateClassicOmNomPreview Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CandySelectionView.md

Creates a classic Om Nom preview object, optionally animated. The preview build state is updated if an animated preview is generated.

```csharp
private static GameObject CreateClassicOmNomPreview(bool animated, CandySelectionView.OmNomPreviewBuildState previewState)
```

--------------------------------

### GetStringsFullPath

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Helpers/ContentPaths.md

Gets the full path to a per-language localization JSON file.

```APIDOC
## GetStringsFullPath

### Description
Gets the full path to a per-language localization JSON file.

### Method
N/A (This is a helper function, not an API endpoint)

### Parameters
#### Path Parameters
- **languageCode** (string) - Required - Language code used to resolve the strings file.

### Response
#### Success Response
- **string** - The full path to the requested localization file.
```

--------------------------------

### GetTargetBaseScaleY

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/OriginalTargetAnimationBackend.md

Gets the default vertical scale that should be applied to the target object.

```APIDOC
## GetTargetBaseScaleY()

### Description
Gets the default vertical scale that should be applied to the target object.

### Method
public float

### Returns
Default Y scale for the target object.
```

--------------------------------

### Initialize TileMap

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/TileMap.md

Sets up the grid dimensions for the tile map.

```csharp
public TileMap InitWithRowsColumns(int r, int c)
```

--------------------------------

### InitWithLoading Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Processing.md

Initializes the processing overlay, optionally including a loading indicator and text.

```APIDOC
## POST /api/processing/init

### Description

Initializes the processing overlay. This method can optionally include a spinning loading indicator and processing text.

### Method

POST

### Endpoint

`/api/processing/init`

### Parameters

#### Query Parameters

- **loading** (boolean) - Required - Whether to include the spinning loading indicator and processing text.

### Request Body

(No request body specified for this operation)

### Response

#### Success Response (200)

- **Processing** (Processing) - The initialized processing overlay.

### Request Example

(No request example provided)

### Response Example

```json
{
  "Processing": {
    "initialized": true
  }
}
```
```

--------------------------------

### GetTargetBaseScaleX

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/OriginalTargetAnimationBackend.md

Gets the default horizontal scale that should be applied to the target object.

```APIDOC
## GetTargetBaseScaleX()

### Description
Gets the default horizontal scale that should be applied to the target object.

### Method
public float

### Returns
Default X scale for the target object.
```

--------------------------------

### GetCollisionRadius()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Sock.md

Gets the transporter collision radius for magic hat instances.

```APIDOC
## GetCollisionRadius()

### Description
Gets the transporter collision radius for magic hat instances.

### Method
`private static float GetCollisionRadius()`

### Returns
- `float`: The collision radius in world units.
```

--------------------------------

### CreateOptions

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/MenuController.md

Builds the options view.

```csharp
public void CreateOptions()
```

--------------------------------

### GetSleepPulseDelaySeconds

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/OriginalTargetAnimationBackend.md

Gets the delay before night sleep pulse effects should begin.

```APIDOC
## GetSleepPulseDelaySeconds()

### Description
Gets the delay before night sleep pulse effects should begin.

### Method
public float

### Returns
Delay in seconds.
```

--------------------------------

### BuildOmNomWarmupSlots Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CandySelectionView.md

Builds a batch of Om Nom skin slots for an in-progress warmup grid. Specify the warmup state and the maximum number of slots to build.

```csharp
private static void BuildOmNomWarmupSlots(CandySelectionView.OmNomWarmupState warmupState, int slotCount)
```

--------------------------------

### Start Incremental Resource Loading

Source: https://context7.com/yell0wsuit/ctrdx-docs/llms.txt

Begin the resource loading process incrementally. Assign a delegate to `resourcesDelegate` to receive progress updates and call `StartLoading()`.

```csharp
resourceMgr.resourcesDelegate = new ResourceLoadDelegate();
resourceMgr.StartLoading();
```

--------------------------------

### Get UnlockStars

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/PackDefinition.md

Retrieves the number of stars required to unlock the pack.

```csharp
public int UnlockStars { get; }
```

--------------------------------

### Select video player backend method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/VideoPlayerBackendSelector.md

Determines the best available video player backend based on platform and library support flags.

```csharp
public static VideoPlayerBackend Select(bool isMac, bool isMac26OrLater, bool hasAvFoundation, bool hasFfmpeg)
```

--------------------------------

### Get MinScale property

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Bouncer.md

Retrieves the minimum scale applied while on the transporter.

```csharp
public float MinScale { get; }
```

--------------------------------

### Get Current Drawing Color

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Desktop/Renderer.md

Returns the current drawing color.

```csharp
public static Color GetCurrentColor()
```

--------------------------------

### CTRRootController Constructor

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CTRRootController.md

Initializes the root controller, loads startup resources, and adds the startup child controller.

```APIDOC
## CTRRootController(ViewController parent)

### Description
Initialises the root controller, loads startup resources, and adds the startup child controller.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### GetSound Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/SoundMgr.md

Gets or loads a sound effect by its resource name.

```APIDOC
## GetSound(string soundResourceName)

### Description
Gets or loads a sound effect by its resource name.

### Method
`public SoundEffect`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **soundResourceName** (`string`) - Required - Logical sound resource name to resolve and load.

### Request Example
None

### Response
#### Success Response (200)
- **SoundEffect** (`SoundEffect`) - The loaded sound effect, or `null` when the name is invalid, localized lookup fails, or the resource is music.

### Response Example
None
```

--------------------------------

### Start Om Nom Warmup

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CandySelectionView.md

Initiates the Om Nom grid warmup process and background XML preparsing. This is an incremental process.

```csharp
private static void StartOmNomWarmup()
```

--------------------------------

### GetPercentLoaded API

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/ResourceMgr.md

Gets the percentage of queued resources that have completed loading.

```APIDOC
## GetPercentLoaded /api/resources/loading/progress

### Description
Returns the percentage of queued resources that have completed loading.

### Method
GET

### Endpoint
/api/resources/loading/progress

### Response
#### Success Response (200)
- **percentage** (int) - Load completion percentage from 0 to 100.
```

--------------------------------

### Initialization and State

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/FlashXmlTargetAnimationBackend.md

Methods for initializing the backend and checking animation playback states.

```APIDOC
## Initialize(ITimelineDelegate timelineDelegate)

### Description
Initializes playback and binds the external timeline delegate.

### Parameters
#### Path Parameters
- **timelineDelegate** (ITimelineDelegate) - Required - Delegate that receives timeline callbacks.

## IsPlaying(TargetAnimationState state)

### Description
Determines whether the timeline for a target animation state is currently playing.

### Parameters
#### Path Parameters
- **state** (TargetAnimationState) - Required - Target animation state to inspect.

### Response
- **Returns** (bool) - true if the mapped timeline is active and playing; otherwise, false.
```

--------------------------------

### Access VectorPoint property

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/VectorClass.md

Gets or sets the wrapped Vector value.

```csharp
public Vector VectorPoint { get; set; }
```

--------------------------------

### CreateMainMenu

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/MenuController.md

Builds the main menu view.

```APIDOC
## CreateMainMenu

### Description
Builds the main menu view.

### Method
POST

### Endpoint
/api/menu/main

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **View** (object) - The main menu view.

#### Response Example
```json
{
  "viewType": "MainMenu"
}
```
```

--------------------------------

### Create About View Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/MenuController.md

Constructs the view for the about and credits screen.

```csharp
public void CreateAbout()
```

--------------------------------

### BuildOmNomWarmupSlots

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CandySelectionView.md

Builds a batch of Om Nom skin slots into an in-progress warmup grid.

```APIDOC
## BuildOmNomWarmupSlots(CandySelectionView.OmNomWarmupState warmupState, int slotCount)

### Description
Builds a batch of Om Nom skin slots into an in-progress warmup grid.

### Method
private static void

### Parameters
#### Path Parameters
- **warmupState** (CandySelectionView.OmNomWarmupState) - Required - Warmup state that owns the grid under construction.
- **slotCount** (int) - Required - Maximum number of slots to build.
```

--------------------------------

### TriggerBlink Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/ITargetAnimationBackend.md

Initiates the blink overlay animation starting from the first frame.

```csharp
public abstract void TriggerBlink()
```

--------------------------------

### Mark Startup Resource Loading Complete

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/StartupController.md

Marks startup resource loading as complete. Call this method when all necessary resources have been loaded.

```csharp
public void AllResourcesLoaded()
```

--------------------------------

### OnTouchDown

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Lantern.md

Handles a touch against the lantern and starts candy release when the lantern is active.

```csharp
public bool OnTouchDown(float tx, float ty)
```

--------------------------------

### Initialize GameController

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Constructor for creating a new instance of the game controller.

```csharp
public GameController(ViewController parent)
```

--------------------------------

### InitiateReleasingCandy

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Lantern.md

Starts the delayed release animation sequence for the shared captured candy.

```csharp
private void InitiateReleasingCandy()
```

--------------------------------

### Constructor: StartupController

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/StartupController.md

Initializes a new instance of the StartupController class with a specified parent view controller.

```APIDOC
## Constructor StartupController

### Description
Initializes a startup controller instance.

### Parameters
#### Path Parameters
- **parent** (ViewController) - Required - Parent view controller.
```

--------------------------------

### InitWithPath

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/CTRTexture2D.md

Loads and registers a texture from a given resource path.

```APIDOC
## InitWithPath(string path)

### Description
Loads the texture from the given resource `path` and registers it.

### Method
public CTRTexture2D InitWithPath(string path)

### Parameters
#### Path Parameters
- **path** (string) - Required - Resource path to load from.

### Returns
- **CTRTexture2D** - The initialized texture instance, or `null` if loading fails.
```

--------------------------------

### SetCut

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Bungee.md

Marks the bungee as cut at a segment index and starts the cut fade.

```APIDOC
## SetCut

### Description
Marks the bungee as cut at a segment index and starts the cut fade.

### Method
public void

### Parameters
#### Path Parameters
- **part** (int) - Required - Index of the segment part where the bungee was cut.

### Request Example
```json
{
  "part": 3
}
```

### Response
#### Success Response (200)
- No specific return value documented.

#### Response Example
```json
// No response body for this method
```
```

--------------------------------

### Create controller instance

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/TargetAnimationController.md

Static factory method to instantiate the controller.

```csharp
public static TargetAnimationController Create(ITargetAnimationBackend backend)
```

--------------------------------

### AntsPathSegment startPoint Field

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/AntsPathSegment.md

The world-space coordinates of the segment's start point.

```csharp
public Vector startPoint
```

--------------------------------

### Create and Manage MenuController

Source: https://context7.com/yell0wsuit/ctrdx-docs/llms.txt

Demonstrates how to create a custom ViewController, register views with IDs, and display them. Use this for hierarchical menu structures.

```csharp
public class MenuController : ViewController
{
    private const int VIEW_MAIN_MENU = 0;
    private const int VIEW_SETTINGS = 1;

    public MenuController(ViewController parent) : base(parent) { }

    public override void Activate()
    {
        base.Activate();

        // Register views
        var mainMenuView = new View();
        AddViewwithID(mainMenuView, VIEW_MAIN_MENU);

        var settingsView = new View();
        AddViewwithID(settingsView, VIEW_SETTINGS);

        // Show initial view
        ShowView(VIEW_MAIN_MENU);
    }

    public void OpenSettings()
    {
        ShowView(VIEW_SETTINGS);
    }

    public override void Update(float delta)
    {
        base.Update(delta);
        // Custom update logic
    }
}
```

--------------------------------

### Get SittingPlatform

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/PackDefinition.md

Retrieves the quad index in CharSupports used for the support platform.

```csharp
public int SittingPlatform { get; }
```

--------------------------------

### Initialize Game1

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Game1.md

Constructor for initializing the game window, graphics device manager, and event handlers.

```csharp
public Game1()
```

--------------------------------

### Get PackSpritesheet

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/PackDefinition.md

Retrieves the resource ID for the spritesheet containing the box sprite.

```csharp
public string PackSpritesheet { get; }
```

--------------------------------

### VideoPlayerFFmpeg Initialization and Resource Management

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/VideoPlayerFFmpeg.md

Methods for initializing FFmpeg contexts, managing audio components, and disposing of resources.

```APIDOC
## InitializeFfmpeg(string filePath)

### Description
Initializes FFmpeg contexts and opens the video file for decoding.

### Parameters
#### Request Body
- **filePath** (string) - Required - Full path to the video file.

### Response
- **Returns** (bool) - true if initialization succeeded; otherwise, false.

## InitializeAudio()

### Description
Initializes audio decoding and playback components.

### Response
- **Returns** (bool) - true if audio initialization succeeded or no audio stream exists; otherwise, false.

## Dispose()

### Description
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
```

--------------------------------

### Initialize particle system

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/RocketSparks.md

Configures the particle system with count, angle, and image grid settings.

```csharp
public virtual Particles InitWithTotalParticlesAngleandImageGrid(int p, float a, Image grid)
```

--------------------------------

### Get PackQuadIndex

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/PackDefinition.md

Retrieves the quad index within the PackSpritesheet for the box sprite.

```csharp
public int PackQuadIndex { get; }
```

--------------------------------

### OmNomSlotPreviewLayout.Resolve Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/OmNomSlotPreviewLayout.md

Gets the layout values for an Om Nom preview mode.

```APIDOC
## Resolve(OmNomSlotPreviewMode previewMode)

### Description
Gets the layout values for an Om Nom preview mode.

### Method
GET

### Endpoint
/api/OmNomSlotPreviewLayout/Resolve

### Parameters
#### Query Parameters
- **previewMode** (OmNomSlotPreviewMode) - Required - Preview mode to lay out.

### Response
#### Success Response (200)
- **scale** (float) - The scale for the preview mode.
- **verticalOffset** (float) - The vertical offset for the preview mode.

### Response Example
{
  "scale": 1.5,
  "verticalOffset": 0.2
}
```

--------------------------------

### Get Last Segment

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/MechanicalHand.md

Returns the terminal segment of the mechanical hand chain.

```csharp
public MechanicalHandSegment LastSegment()
```

--------------------------------

### Initialize Track

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/Track.md

Sets up a track with a parent timeline, track type, and keyframe capacity.

```csharp
public Track InitWithTimelineTypeandMaxKeyFrames(Timeline timeline, Track.TrackType trackType, int m)
```

--------------------------------

### Get TargetObject Property

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/ITargetAnimationBackend.md

Retrieves the primary gameplay object associated with the target.

```csharp
public GameObject TargetObject { get; }
```

--------------------------------

### Start Particle System Emission

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/Particles.md

Initiates the particle system and spawns an initial batch of particles. The system will then begin emitting particles based on its configuration.

```csharp
public virtual void StartSystem(int initialParticles)
```

--------------------------------

### Get device scale

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/AntsPath.md

Calculates the effective scale factor for conveyor geometry.

```csharp
private static float GetDeviceScaledFactor(float pathScale)
```

--------------------------------

### Initialize ViewController

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/ViewController.md

Constructors for creating a controller instance, optionally with a parent controller.

```csharp
protected ViewController()
```

```csharp
protected ViewController(ViewController parent)
```

--------------------------------

### WarmOmNomGridIncrementally

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/CandySelectionView.md

Builds a portion of the Om Nom grid slots after background preparation is complete.

```APIDOC
## WarmOmNomGridIncrementally

### Description
Builds a small batch of Om Nom grid slots when background preparse work is complete.

### Method
private static

### Endpoint
N/A (Internal method)

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Get Frame Time

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/Track.md

Retrieves the cumulative time up to the specified keyframe index.

```csharp
public float GetFrameTime(int f)
```

--------------------------------

### Method: GetProbeLibrary

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/FfmpegRootPathResolver.md

Gets a library name pattern to probe for FFmpeg presence.

```APIDOC
## GetProbeLibrary()

### Description
Gets a library name pattern to probe for FFmpeg presence.

### Response
- **Returns** (string) - A platform-specific library filename pattern.
```

--------------------------------

### ConstraintSystem Class Overview

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Physics/ConstraintSystem.md

Provides an overview of the ConstraintSystem class, its namespace, assembly, and source file.

```APIDOC
## Class ConstraintSystem

Namespace: `CutTheRopeDX.Framework.Physics`

Assembly: `CutTheRope-DX.dll`

Source: `ConstraintSystem.cs`

Base collection of constrained points that updates particles and relaxes constraints.
```

--------------------------------

### StartAnimation()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Rocket.md

Enables and plays the spark animation for the rocket.

```APIDOC
## StartAnimation()

### Description
Enables the spark animation and begins playing it.

### Method
`public void StartAnimation()`

### Endpoint
N/A (Method call)

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Method: GetCandidatePaths

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Media/FfmpegRootPathResolver.md

Gets the platform-specific candidate directories to search for FFmpeg libraries.

```APIDOC
## GetCandidatePaths(string appBaseDirectory)

### Description
Gets the platform-specific candidate directories to search for FFmpeg libraries.

### Parameters
- **appBaseDirectory** (string) - Required - Base application directory used to build probe paths.

### Response
- **Returns** (string[]) - Candidate directories to probe for FFmpeg binaries.
```

--------------------------------

### PrepareToRelease Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/WaterElement.md

Marks the water element for release.

```APIDOC
## PrepareToRelease()

### Description
Marks this water element for release, cancelling all pending dispatches and suppressing further drawing/updating.

### Method
`public void PrepareToRelease()`
```

--------------------------------

### StartMovingToSpointInDirection

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/ScrollableContainer.md

Starts snap-to-point movement by selecting the nearest scroll point in the supplied direction.

```APIDOC
## StartMovingToSpointInDirection(Vector d)

### Description
Starts snap-to-point movement by selecting the nearest scroll point in the supplied direction.

### Method
void

### Endpoint
N/A (Class Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Initialize FlashXmlTargetAnimationBackend

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/FlashXmlTargetAnimationBackend.md

Constructor for creating a new backend instance using a provided skin definition.

```csharp
public FlashXmlTargetAnimationBackend(OmNomSkinDefinition skinDefinition)
```

--------------------------------

### PlayTimeline Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/BaseElement.md

Starts playback of the timeline at the specified slot, stopping any active timeline.

```csharp
public virtual void PlayTimeline(int t)
```

--------------------------------

### Access initialAngle field

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/RotatableScalableMultiParticles.md

Defines the starting rotation angle for new particles in radians.

```csharp
public float initialAngle
```

--------------------------------

### CreateGameView()

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/GameController.md

Creates the game scene, HUD buttons, pause menu, result box, and optional overlays.

```csharp
public void CreateGameView()
```

--------------------------------

### Sample path

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/QuadraticBezierSpline.md

Samples a smooth path through control points for visualization purposes.

```csharp
public static Vector[] SamplePath(IReadOnlyList<Vector> controlPoints, int subdivisionsPerCurve)
```

--------------------------------

### Get Toggled Group

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/Spikes.md

Retrieves the toggle group identifier for the rotatable spike set.

```csharp
public int GetToggled()
```

--------------------------------

### Initialize Desktop Renderer

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Desktop/Renderer.md

Initializes the OpenGL emulation layer. Must be called before any rendering operations. Sets up BasicEffect shaders and rasterizer states.

```csharp
public static void Init()
```

--------------------------------

### Get point for parameter

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/QuadraticBezierSpline.md

Evaluates the spline at a specific parameter, handling segment overflow.

```csharp
public Vector GetPointForParam(float param)
```

--------------------------------

### InitWithMaxKeyFramesOnTrack Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Visual/Timeline.md

Initializes the timeline, setting the maximum number of keyframes allowed per track. Returns the initialized timeline instance.

```csharp
public Timeline InitWithMaxKeyFramesOnTrack(int m)
```

--------------------------------

### PrepareToRelease Method

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/WaterElement.md

Marks the water element for release, cancelling pending dispatches and suppressing further drawing or updating.

```csharp
public void PrepareToRelease()
```

--------------------------------

### RotationDelta

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/MechanicalHandSegment.md

Gets the per-frame rotation delta used to rotate attached candy visuals.

```APIDOC
## RotationDelta

### Description
Gets the per-frame rotation delta used to rotate attached candy visuals.

### Response
- **Returns** (float) - Rotation delta in degrees.
```

--------------------------------

### Define Application lifecycle and factory methods

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/Framework/Core/Application.md

Methods for initializing the application and creating shared service instances.

```csharp
public virtual void ApplicationDidFinishLaunching()
```

```csharp
public virtual ApplicationSettings CreateAppSettings()
```

```csharp
public virtual GLCanvas CreateCanvas()
```

```csharp
public virtual MovieMgr CreateMovieMgr()
```

```csharp
public virtual CTRPreferences CreatePreferences()
```

```csharp
public virtual CTRResourceMgr CreateResourceMgr()
```

```csharp
public virtual RootController CreateRootController()
```

```csharp
public static SoundMgr CreateSoundMgr()
```

--------------------------------

### Direction Property

Source: https://github.com/yell0wsuit/ctrdx-docs/blob/main/docs/CutTheRopeDX/GameMain/ConveyorBelt.md

Gets the normalized direction vector along the belt's length.

```csharp
public Vector Direction { get; }
```
Tokens:
Raw