Docs/Configuration and Parts

HeroBridge API

Configuration and Parts API

Configure a character, apply parts, and cycle part categories from code.

API: Configuration and Parts

All API examples start with a Sidekick Character reference:

csharp
var sidekick = characterGameObject.GetComponent<SidekickCharacter>();

Configuration

csharp
sidekick.SetRebuildAnimatorRoot(bool value);
sidekick.SetResetBody(bool value);
sidekick.SetUseMatchingParts(bool value);
sidekick.SetIncludeNone(bool value);

SetRebuildAnimatorRoot rebuilds the Animator hierarchy when HeroBridge applies parts. SetResetBody removes parts that are not in the new setup when it is true. SetUseMatchingParts applies matching left and right parts when they are available. SetIncludeNone lets part cycling remove the current part.

Parts

csharp
sidekick.SetPart(string partValue);
sidekick.RemovePart(string partTypeString);

SetPart accepts one part identifier or several identifiers separated by commas.

csharp
sidekick.SetPart("SK_HUMN_BASE_01_01HEAD_HU01");
sidekick.SetPart("SK_HUMN_BASE_01_01HEAD_HU01,SK_HUMN_BASE_01_02HAIR_HU01");

RemovePart accepts a PascalCase part type without spaces, such as Hair, Head, or Torso.

Cycle Parts

csharp
sidekick.CycleNext(string partType);
sidekick.CyclePrevious(string partType);
sidekick.CycleRandom(string partType);

Use a part type such as Hair or Head to choose which category to cycle.