Afterbirth+ Documentation
  • README
  • beta
    • docs
      • Class "RoomConfig::Entry"
      • Class "ItemConfig::Card"
      • Class "PlayerTypes::PosVel"
      • enums
        • Enum "DoorVariant"
        • CollectibleType
        • Enum "ActionTriggers"
        • Enum "Card"
        • Enum "NpcState"
        • Enum "EffectVariant"
        • Enum "EntityGridCollisionClass"
        • Enum "EntityFlag"
        • Enum "LocustSubtypes"
        • Enum "LevelCurse"
        • Enum "GridRooms"
        • Enum "TrinketType"
        • Enum "SortingLayer"
        • Enum "ItemType"
        • Enum "GridCollisionClass"
        • Enum "ModCallbacks"
        • Enum "DoorSlot"
        • Enum "CacheFlag"
        • Enum "PillEffect"
        • Enum "EntityCollisionClass"
        • Enum "ItemPoolType"
        • Enum "PickupPrice"
        • Enum "InputHook"
        • Enum "ButtonAction"
        • Enum "PlayerSpriteLayer"
        • Enum "Keyboard"
        • Enum "GameStateFlag"
        • Enum "PillColor"
        • Enum "CoinSubType"
        • Enum "PlayerForm"
        • Enum "PickupVariant"
        • Enum "GridEntityType"
        • Enum "EntityPartition"
        • Enum "SeedEffect"
        • Enum "RoomShape"
        • Enum "Mouse"
        • Enum "TearFlags"
        • Enum "Music"
        • Enum "BabySubType"
        • Enum "BombVariant"
        • Enum "DoorState"
        • Enum "Challenge"
        • Enum "TearVariant"
        • Enum "EntityType"
        • Enum "SoundEffect"
        • Enum "FamiliarVariant"
        • Enum "PlayerType"
        • Enum "Difficulty"
        • Enum "DamageFlag"
        • Enum "Direction"
        • Enum "KeySubType"
        • Enum "LaserOffset"
        • Enum "ProjectileFlags"
        • Enum "LevelStage"
        • Enum "PlayerItemState"
        • Enum "LevelStateFlag"
        • Enum "ChestSubType"
        • Enum "ProjectileVariant"
        • Enum "WeaponType"
        • Enum "RoomType"
        • Enum "NullItemID"
        • Enum "StageType"
        • Enum "HeartSubType"
        • Enum "BombSubType"
      • Class "Isaac"
      • Class "ProjectileParams"
      • Class "Font"
      • Class "ItemPool"
      • Class "GridEntityRock"
      • tutorials
        • Class "[Tutorial]Rendertext"
        • Tutorial: Example Project
        • Class "XMLFiledocumentation"
        • Class "Writingscreenshaders"
        • Class "DebugConsole"
        • [Tutorial] Adding Costumes to items without LUA
        • Class "Usingadditional.luaFiles"
        • [Tutorial] Debugging with ZeroBrane Studio
      • Class "CppContainer::Vector::ItemConfigList"
      • Class "EntityProjectile"
      • Class "CppContainer::ArrayProxy"
      • Class "CppContainer::Vector::CardConfigList"
      • Class "PathFinder"
      • Class "ItemConfig::PillEffect"
      • Class "CppContainer::Vector::EffectList"
      • Class "RoomDescriptor"
      • Class "GridEntity"
      • Class "GridEntityPoop"
      • PLACEHOLDER
      • Class "TearParams"
      • Class "GridEntityPit"
      • Class "EntityFamiliar"
      • Class "MusicManager"
      • Class "SFXManager"
      • Lua API Documentation for The Binding of Isaac - Afterbirth+
      • Class "GridEntityTNT"
      • Class "EntityRef"
      • Class "Sprite"
      • Class "EntityBomb"
      • Class "EntityTear"
      • Class "QueueItemData"
      • Class "EntityPlayer"
      • Class "Vector"
      • Class "Entity"
      • Class "ItemConfig::Config"
      • Class "CppContainer::ArrayProxy::RoomList"
      • Class "RNG"
      • Class "EntityPtr"
      • Class "Input"
      • Class "EntityPickup"
      • Class "EntityLaser"
      • Class "GridEntityPressurePlate"
      • Class "CppContainer::Vector::VectorList"
      • Class "Room"
      • Class "CppContainer::Vector::CostumeConfigList"
      • Class "GridEntityDesc"
      • Class "Level"
      • Class "RoomConfig::Spawn"
      • Class "Color"
      • Class "KColor"
      • Class "TemporaryEffect"
      • Class "EntityKnife"
      • Class "Seeds"
      • Class "CppContainer::EntityList"
      • Class "GridEntityDoor"
      • Class "ShockwaveParams"
      • Class "ItemConfig::Costume"
      • Class "GridEntitySpikes"
      • Class "EntityEffect"
      • Class "CppContainer::Vector::PillConfigList"
      • Class "EntityNPC"
      • Class "RoomDescriptorData"
      • Class "ItemConfig::Item"
      • Class "RoomConfig::Room"
      • Class "Game"
      • Class "TemporaryEffects"
      • Class "PlayerTypes::ActiveItemDesc"
      • Class "Global Functions"
Powered by GitBook
On this page
  • Constructors
  • Color () {: aria-label='Constructors' }
  • Functions
  • __mul () {: aria-label='Functions' }
  • Lerp () {: aria-label='Functions' }
  • Reset () {: aria-label='Functions' }
  • SetColorize () {: aria-label='Functions' }
  • SetOffset () {: aria-label='Functions' }
  • SetTint () {: aria-label='Functions' }
  • Variables
  • A {: aria-label='Variables' }
  • B {: aria-label='Variables' }
  • BO {: aria-label='Variables' }
  • G {: aria-label='Variables' }
  • GO {: aria-label='Variables' }
  • R {: aria-label='Variables' }
  • RO {: aria-label='Variables' }

Was this helpful?

  1. beta
  2. docs

Class "Color"

PreviousClass "RoomConfig::Spawn"NextClass "KColor"

Last updated 4 years ago

Was this helpful?

Constructors

() {: aria-label='Constructors' }

{: .abp .tooltip .badge }

void ( float R, float G, float B, float A, int RO, int GO, int BO ) {: .copyable aria-label='Constructors' }

Constructor for the "Color" class.

When using the class, use instead.

Colors are made of three separate components, tint, colorize and offset. Tint acts like a color multiplicator. Offset is a color which is added after the tint is applied. Colorize is complicated. See the :::lua SetColorize() function for a detailed description.

R, G, B and A accept numbers between 0 and 1.

RO, GO and BO accept numbers between -255 and 255.

Functions

__mul () {: aria-label='Functions' }

{: .abp .tooltip .badge }

__mul ( right ) {: .copyable aria-label='Functions' }

Multiplication of two colors.

Lerp () {: aria-label='Functions' }

Linear Interpolation between two colors. :::lua t is the "progress" of the interpolation. Setting :::lua t = 0.5 means that the color in the middle of m1 and m2 will be returned.

Reset () {: aria-label='Functions' }

void Reset ( ) {: .copyable aria-label='Functions' }

SetColorize () {: aria-label='Functions' }

void SetColorize ( float Red, float Green, float Blue, float Amount ) {: .copyable aria-label='Functions' }

The colorize function can be used to change the color of sprites. Its the best for that purpose, since it doesnt affect existing coloranimations like the flashing of creep.

The values can be between 0 and 1 for normal coloration. if you use higher numbers the color gets more vibrant.

???- note "Notes" The alpha component determines how much colorization must be applied. The function takes the original color, converts it to grayscale, multiplies it by the RGB components and then blends it back with the original color. The alpha value determines the blending factor. Colorization is applied after the tint and before the offset function.

???- example "Example Code" :::lua SetColorize(1, 1, 1, 1) will turn the sprite into grayscale.

 `:::lua SetColorize(1, 0, 0, 1)` will turn it red but not as a red tint but as shades of red.


`:::lua SetColorize(1, 1, 1, 2)` will invert the sprite without touching its luminosity.



This code changes the color of red Creep to be purple
```lua 
Test:AddCallback(ModCallbacks.MC_POST_EFFECT_INIT, function(_, self)
if self.Variant == EffectVariant.CREEP_RED then
local color = Color(1, 1, 1, 1, 0, 0, 0)
color:SetColorize(4, 0, 4, 1)
self:GetSprite().Color = color
end
end)

```

SetOffset () {: aria-label='Functions' }

void SetOffset ( float RedOffset, float GreenOffset, float BlueOffset ) {: .copyable aria-label='Functions' }

Offset is a color that gets added to the sprite after the Tint was applied.

SetTint () {: aria-label='Functions' }

void SetTint ( float RedTint, float GreenTint, float BlueTint, float AlphaTint ) {: .copyable aria-label='Functions' }

Tint acts like a color multiplicator.

Variables

A {: aria-label='Variables' }

float A {: .copyable aria-label='Variables' }

B {: aria-label='Variables' }

float B {: .copyable aria-label='Variables' }

BO {: aria-label='Variables' }

float BO {: .copyable aria-label='Variables' }

G {: aria-label='Variables' }

float G {: .copyable aria-label='Variables' }

GO {: aria-label='Variables' }

float GO {: .copyable aria-label='Variables' }

R {: aria-label='Variables' }

float R {: .copyable aria-label='Variables' }

RO {: aria-label='Variables' }

float RO {: .copyable aria-label='Variables' }

{: .static .tooltip .badge } {: .abp .tooltip .badge }

static Lerp ( m1, m2, float t ) {: .copyable aria-label='Functions' }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

Color
Color
Font
KColor()
Color
Color
Color
Color
Color