Skip to content

Chippy Documentation Sample

Type to start searching

Facepunch/chippy-docs

Chippy Documentation

Facepunch/chippy-docs

Chippy Docs
Tutorials
Tutorials
- Overview
- Getting Started
- Bullet Patterns
- Bullets
- Units
- Unit Parts
- Actions
- Stages
- Player
- Status Effects
- SFX
- Music
- Pixel Editor
- Utilities
- Workshop
SpaceUsurper
SpaceUsurper
- ActionList
  ActionList
  - ActionList
- AnimatedSpriteController
  AnimatedSpriteController
  - AnimatedSpriteController
  - Methods
    Methods
    
    PlayAnim
    
    SetAngle
    
    SetPosition
    
    SetSize
- ArenaData
  ArenaData
  - ArenaData
  - Properties
    Properties
    
    BgColor
    
    Bounds
    
    GridColor
    
    GridEdgeScale
    
    GridEdgeWarp
    
    GridEdgeWidth
    
    GridSpacing
    
    GridThickness
    
    LetterboxColor
    
    SmallClampingModeX
    
    SmallClampingModeY
- Background
  Background
  - Background
  - Properties
    Properties
    
    FadeOpacity
    
    IsFading
    
    IsVisible
  - Methods
    Methods
    
    Hide
    
    Show
- BackgroundData
  BackgroundData
  - BackgroundData
  - Properties
    Properties
    
    bakedPixelsPerUnit
    
    bakedWorldSize
    
    bakeToTexture
    
    shaderFlags
    
    spawnAngle
    
    spawnBlinkPeriodA
    
    spawnBlinkPeriodB
    
    spawnBlinkPeriodC
    
    spawnBounds
    
    spawnColor1
    
    spawnColor2
    
    spawnColorA1
    
    spawnColorA2
    
    spawnColorB1
    
    spawnColorB2
    
    spawnColorC1
    
    spawnColorC2
    
    spawnDepthLevel
    
    spawnExtraFrameSize
    
    spawnFloatVar
    
    spawnGlow
    
    spawnGlowA
    
    spawnGlowB
    
    spawnGlowC
    
    spawnOpacity
    
    spawnParallax
    
    spawnPositionVariance
    
    spawnRadius
    
    spawnRotateChannels
    
    spawnSpacing
    
    spawnSpriteIndex
    
    spawnSprites
    
    SubLayers
    
    updateAngle
    
    updateBlinkPeriodA
    
    updateBlinkPeriodB
    
    updateBlinkPeriodC
    
    updateColor1
    
    updateColor2
    
    updateColorA1
    
    updateColorA2
    
    updateColorB1
    
    updateColorB2
    
    updateColorC1
    
    updateColorC2
    
    updateFloatVar
    
    updateGlow
    
    updateGlowA
    
    updateGlowB
    
    updateGlowC
    
    updateOpacity
    
    updateRadius
    
    useSpriteAsBakedTexture
- BackgroundData+SubLayerData
  BackgroundData+SubLayerData
  - BackgroundData+SubLayerData
  - Properties
    Properties
    
    spawnAngle
    
    spawnAngularVelocity
    
    spawnBlinkPeriodA
    
    spawnBlinkPeriodB
    
    spawnBlinkPeriodC
    
    spawnColor1
    
    spawnColor2
    
    spawnColorA1
    
    spawnColorA2
    
    spawnColorB1
    
    spawnColorB2
    
    spawnColorC1
    
    spawnColorC2
    
    spawnGlow
    
    spawnGlowA
    
    spawnGlowB
    
    spawnGlowC
    
    spawnOffset
    
    spawnOpacity
    
    spawnParallax
    
    spawnRotateAround
    
    spawnScale
    
    spawnVelocity
    
    updateAngle
    
    updateAngularVelocity
    
    updateBlinkPeriodA
    
    updateBlinkPeriodB
    
    updateBlinkPeriodC
    
    updateColor1
    
    updateColor2
    
    updateColorA1
    
    updateColorA2
    
    updateColorB1
    
    updateColorB2
    
    updateColorC1
    
    updateColorC2
    
    updateGlow
    
    updateGlowA
    
    updateGlowB
    
    updateGlowC
    
    updateOpacity
    
    updateRotateAround
    
    updateScale
    
    updateVelocity
- BackgroundElement
  BackgroundElement
  - BackgroundElement
- BackgroundSubLayer
  BackgroundSubLayer
  - BackgroundSubLayer
- BaseActions
  BaseActions
  - BaseActions
- Bullet
  Bullet
- BulletData
  BulletData
- BulletFacingMode
  BulletFacingMode
  - BulletFacingMode
- BulletKeyframeData
  BulletKeyframeData
  - BulletKeyframeData
  - Properties
    Properties
    
    acceleration
    
    cantBeAffected
    
    chance
    
    colorA1
    
    colorA2
    
    colorB1
    
    colorB2
    
    colorBlinkTime
    
    colorC1
    
    colorC2
    
    crossDistance
    
    crossWidth
    
    duration
    
    easingType
    
    facingMode
    
    facingSpeedPercent
    
    frictionPercent
    
    glowA
    
    glowB
    
    glowC
    
    ignorePixelCollision
    
    ignorePlayerCollision
    
    isPositive
    
    length
    
    loopEnd
    
    loopModulus
    
    loopStart
    
    moveAngle
    
    moveMode
    
    next
    
    opacity
    
    pixelDamagePercent
    
    posLerpSpeed
    
    proximityEnabled
    
    radius
    
    rectSize
    
    rectWidthMods
    
    rotationSpeed
    
    SpriteIndex
    
    SpritePath
    
    SpritePaths
    
    targetFacingAngle
    
    targetPos
    
    velocityMode
    
    vibrateOnTouchAmount
    
    vibrateOnTouchEasingType
    
    vibrateOnTouchHorizThreshold
  - Handlers
    Handlers
    
    OnKeyframe
- BulletMoveMode
  BulletMoveMode
  - BulletMoveMode
- BulletPattern
  BulletPattern
  - BulletPattern
  - Properties
    Properties
    
    CurrentAngle
    
    ElapsedTime
    
    FloatVar
    
    HasParentBullet
    
    IntVar
    
    IsActive
    
    LastVolleyShootTime
    
    Level
    
    LoopNum
    
    NumChildBullets
    
    NumShotPatternsConstant
    
    NumSpawnedPatternsConstant
    
    NumVolleys
    
    ParentBullet
    
    PatternNum
    
    PatternProgress
    
    Position
    
    Shape
    
    StartTime
    
    TargetPlayer
    
    TimeSinceLastVolley
    
    VectorVar
  - Methods
    Methods
    
    AddBullet
    
    AffectBullets
    
    ClearTargetPlayer
    
    DespawnBulletAnchor
    
    Finish
    
    Get
    
    GetBullet
    
    GetTotalTimeEstimate
    
    RemoveAnchor
    
    SetBulletAnchor
    
    SetFloatVar
    
    SetIntVar
    
    SetPixelGroupAnchor
    
    SetPlayerAnchor
    
    SetPosition
    
    SetTargetPlayer
    
    SetUnitAnchor
    
    SetVectorVar
    
    UpdateTargetPlayer
- BulletTextAlignment
  BulletTextAlignment
  - BulletTextAlignment
- BulletVelocityMode
  BulletVelocityMode
  - BulletVelocityMode
- ButtonPromptData
  ButtonPromptData
  - ButtonPromptData
  - Properties
    Properties
    
    Controller
    
    Keyboard
    
    Mouse
- ButtonPromptData+DeviceStyle
  ButtonPromptData+DeviceStyle
  - ButtonPromptData+DeviceStyle
  - Properties
    Properties
    
    Actions
    
    Aliases
    
    Match
    
    Styles
- ButtonPromptData+Entry
  ButtonPromptData+Entry
  - ButtonPromptData+Entry
  - Properties
    Properties
    
    Background
    
    BackgroundInverted
    
    FontScale
    
    Icon
    
    IconInverted
    
    IconScale
    
    Label
    
    Match
    
    Weight
- ButtonPromptData+Styles
  ButtonPromptData+Styles
  - ButtonPromptData+Styles
  - Properties
    Properties
    
    Default
    
    Inverted
- CallBase
  CallBase
  - CallBase
  - Properties
    Properties
    
    params
    
    params
    
    params
- CallMethod
  CallMethod
  - CallMethod
  - Properties
    Properties
    
    dynamic
    
    ignoreNullRef
    
    method
    
    return
    
    target
    
    type
- CallSubroutine
  CallSubroutine
  - CallSubroutine
  - Properties
    Properties
    
    coroutine
    
    ignoreNullRef
    
    path
    
    target
- CameraMode
  CameraMode
  - CameraMode
- CampaignData
  CampaignData
  - CampaignData
  - Properties
    Properties
    
    BackgroundColor
    
    BackgroundColor
    
    Category
    
    Category
    
    Description
    
    Description
    
    DisableCampaignLeaderboard
    
    DisableCampaignLeaderboard
    
    EnableFlags
    
    EnableFlags
    
    HideInEditor
    
    HideInEditor
    
    InvisibleWhenLocked
    
    InvisibleWhenLocked
    
    OrderIgnoresLockedState
    
    OrderIgnoresLockedState
    
    Stages
    
    Stages
    
    SubtitleColor
    
    SubtitleColor
    
    Title
    
    Title
- CampaignDifficulty
  CampaignDifficulty
  - CampaignDifficulty
- CampaignListData
  CampaignListData
  - CampaignListData
  - Properties
    Properties
    
    _allCampaigns
    
    ColdOpenStage
- CampaignStageData
  CampaignStageData
  - CampaignStageData
- Condition
  Condition
  - Condition
  - Properties
    Properties
    
    condition
    
    False
    
    True
- CoreColorType
  CoreColorType
  - CoreColorType
- CoreController
  CoreController
  - CoreController
  - Properties
    Properties
    
    ChargePercent
    
    IsWandering
    
    LookDirection
    
    LookPercent
    
    ReactPercent
    
    ShootPercent
- CoreData
  CoreData
  - CoreData
  - Properties
    Properties
    
    Base
- CoreLayerData
  CoreLayerData
  - CoreLayerData
  - Properties
    Properties
    
    Angle
    
    BounceAngle
    
    BounceScale
    
    BounceSpeed
    
    ChargeColorFactor
    
    ChargeEasingType
    
    ChargeJitterAngle
    
    ChargeJitterScale
    
    ChargeOffset
    
    ChargeOpacity
    
    ChargeScale
    
    ChargeScaleXY
    
    ChargeWobbleScale
    
    ChargeWobbleSpeed
    
    Color
    
    ColorB
    
    ColorBlinkEasingType
    
    ColorBlinkTime
    
    DespawnEasingType
    
    DespawnScale
    
    DespawnTime
    
    DontRotate
    
    DontRotateOffset
    
    Glow
    
    Image
    
    JitterAngle
    
    JitterScale
    
    LookRadius
    
    Offset
    
    Opacity
    
    pointFilter
    
    ReactEasingType
    
    ReactGlow
    
    ReactJitterAngle
    
    ReactJitterScale
    
    ReactOffset
    
    ReactOpacity
    
    ReactScale
    
    ReactScaleXY
    
    ReactWobbleScale
    
    ReactWobbleSpeed
    
    RotationSymmetry
    
    Scale
    
    ShootColorFactor
    
    ShootEasingType
    
    ShootJitterAngle
    
    ShootJitterScale
    
    ShootOffset
    
    ShootOpacity
    
    ShootScale
    
    ShootScaleXY
    
    ShootSpinSpeed
    
    ShootWobbleScale
    
    ShootWobbleSpeed
    
    SpinSpeed
    
    TintColorFactor
    
    WobbleScale
    
    WobbleSpeed
- DataPath
  DataPath
  - DataPath
- DefaultWorkshopItemsData
  DefaultWorkshopItemsData
  - DefaultWorkshopItemsData
  - Properties
    Properties
    
    SubscribeIdStrings
    
    UnsubscribeIdStrings
- DepthLevel
  DepthLevel
  - DepthLevel
- DepthLevelData
  DepthLevelData
  - DepthLevelData
  - Properties
    Properties
    
    levels
- DepthLevelData+Entry
  DepthLevelData+Entry
  - DepthLevelData+Entry
- DespawnStyle
  DespawnStyle
  - DespawnStyle
- Direction
  Direction
  - Direction
- DummyPlayer
  DummyPlayer
  - DummyPlayer
  - Properties
    Properties
    
    Input
- DummyPlayerInput
  DummyPlayerInput
  - DummyPlayerInput
  - Properties
    Properties
    
    MoveInputPercent
    
    ShootInputPercent
- EaseTestStage
  EaseTestStage
  - EaseTestStage
- EasingType
  EasingType
  - EasingType
- FlipPatternMode
  FlipPatternMode
  - FlipPatternMode
- FloatingTextFont
  FloatingTextFont
  - FloatingTextFont
- FsmAction
  FsmAction
  - FsmAction
- FsmData
  FsmData
  - FsmData
- FsmValue
  FsmValue
  - FsmValue
- FsmValue
  FsmValue
  - FsmValue
- FuncParams
  FuncParams
  - FuncParams
  - Properties
    Properties
    
    Aliases
    
    Include
    
    Insert
    
    Properties
- GameModeBaseData
  GameModeBaseData
  - GameModeBaseData
  - Properties
    Properties
    
    _medalKind
    
    _progressBarMode
    
    _recordProgressTimestamps
    
    _scoreSortMethod
    
    _supportsCampaignLeaderboard
    
    _supportsStageLeaderboard
    
    _timeSortMethod
    
    _useRawTime
- GameModeData
  GameModeData
  - GameModeData
  - Properties
    Properties
    
    ProgressFunction
    
    Properties
    
    ScoreFunction
    
    ShowProgress
    
    ShowTimer
  - Handlers
    Handlers
    
    OnDefeat
    
    OnFormDestroy
    
    OnPlayerDeath
    
    OnSetup
    
    OnUpdate
    
    OnVictory
- GameModeMenuData
  GameModeMenuData
  - GameModeMenuData
- GameStage
  GameStage
- Goto
  Goto
  - Goto
  - Properties
    Properties
    
    state
- HotloadedData
  HotloadedData
  - HotloadedData
- HotloadedData
  HotloadedData
  - HotloadedData
  - Properties
    Properties
    
    Include
    
    PrecacheTextures
- HotloadedData
  HotloadedData
  - HotloadedData
  - Properties
    Properties
    
    Include
    
    Include
    
    PrecacheTextures
    
    PrecacheTextures
- IBackgroundElement
  IBackgroundElement
  - IBackgroundElement
  - Properties
    Properties
    
    Angle
    
    BlinkColorA
    
    BlinkColorB
    
    BlinkColorC
    
    BlinkPeriodA
    
    BlinkPeriodB
    
    BlinkPeriodC
    
    ColorA
    
    ColorB
    
    ColorC
    
    GlowA
    
    GlowB
    
    GlowC
    
    Opacity
    
    Parallax
    
    Position
    
    Radius
- IFsmContainer
  IFsmContainer
  - IFsmContainer
- IntRange
  IntRange
  - IntRange
- IntRect
  IntRect
  - IntRect
- IPositional
  IPositional
  - IPositional
- IPropertyContainer
  IPropertyContainer
  - IPropertyContainer
  - Methods
    Methods
    
    Get
- KeyframeProperty
  KeyframeProperty
  - KeyframeProperty
- Laser
  Laser
  - Laser
  - Properties
    Properties
    
    Dps
- LeaderboardCategory
  LeaderboardCategory
  - LeaderboardCategory
- LoadingTipData
  LoadingTipData
  - LoadingTipData
- LoadingTipListData
  LoadingTipListData
  - LoadingTipListData
  - Properties
    Properties
    
    LoadingTips
- LocalizedString
  LocalizedString
  - LocalizedString
- Log
  Log
  - Log
  - Properties
    Properties
    
    message
- LoopMode
  LoopMode
  - LoopMode
- Medal
  Medal
  - Medal
- MedalData
  MedalData
  - MedalData
- MedalKind
  MedalKind
  - MedalKind
- MenuActions
  MenuActions
  - MenuActions
- MenuStage
  MenuStage
  - MenuStage
- MirrorMode
  MirrorMode
  - MirrorMode
- MovementController
  MovementController
  - MovementController
  - Properties
    Properties
    
    LastPos
    
    MoveDelta
    
    Position
    
    Velocity
    
    VelocityPercent
  - Methods
    Methods
    
    AddForce
    
    AddPhysicsForce
    
    AddVelocity
    
    ClearPhysics
    
    SetAcceleration
    
    SetFrictionPercentMax
    
    SetFrictionPercentMin
    
    SetMass
    
    SetTopSpeed
    
    SetVelocity
- PartSelectMode
  PartSelectMode
  - PartSelectMode
- PatternAimMode
  PatternAimMode
  - PatternAimMode
- PatternData
  PatternData
- PatternShape
  PatternShape
  - PatternShape
- PixelData
  PixelData
  - PixelData
  - Properties
    Properties
    
    BaseColor
    
    Category
    
    CurrentColor
    
    DamagedColor
    
    Exists
    
    OrigBaseColor
    
    OrigDamagedColor
    
    OrigPixelType
    
    ParentPixelGroup
    
    PixelNum
    
    PixelType
    
    Position
    
    Pxc
  - Methods
    Methods
    
    ApplyDamage
    
    Destroy
    
    Flash
    
    IsInPart
    
    Remove
    
    ReplaceColors
    
    Spark
    
    SplashDamage
    
    TransformPixelCircle
    
    TransformPixelLine
- PixelGroup
  PixelGroup
  - PixelGroup
  - Properties
    Properties
    
    BaseHp
    
    CurrentHp
    
    HpPercent
    
    IntRect
    
    IsActive
    
    IsCharging
    
    Laser
    
    LastPatternTime
    
    NumActivePatterns
    
    NumActivePrereqs
    
    NumChargingPatterns
    
    NumPixels
    
    NumSpeechBubbles
    
    NumTimesDestroyed
    
    NumTimesHit
    
    NumTimesHitProtected
    
    PartNum
    
    Position
    
    Unit
  - Methods
    Methods
    
    AddPattern
    
    ChargePattern
    
    Damage
    
    Destroy
    
    DoesPrereqExist
    
    Flash
    
    Heal
    
    HitByArbitrarySource
    
    Look
    
    PlayAnim
    
    React
    
    Remove
    
    RemoveSpeechBubbles
    
    SetAnimSpeed
    
    SetColorBlinkTime
    
    SetColors
    
    SetCore
    
    SetDamagedColorBlinkTime
    
    SetDamagedColors
    
    SetHitFlashColor
    
    SetHitFlashColorDamaged
    
    SetLookTarget
    
    SpawnBubble
    
    StopChargingPatterns
    
    StopPatterns
- PixelJsonTransformation
  PixelJsonTransformation
  - PixelJsonTransformation
- PixelType
  PixelType
  - PixelType
- Player
  Player
  - Player
  - Properties
    Properties
    
    BaseThreat
    
    Body
    
    BoostPercent
    
    ChunkCenterOfMassPos
    
    ChunkDisconnectPos
    
    DamageBonus
    
    DeathPercent
    
    GunHandler
    
    Health
    
    Hitbox
    
    IgnoreBulletDamage
    
    IgnoreLaserDamage
    
    Input
    
    IsCollidingWithPixel
    
    IsDead
    
    IsDying
    
    IsIntangible
    
    LastPixelCollisionTime
    
    Movement
    
    NumChunkPixels
    
    NumDroppableStatusEffects
    
    NumStatusEffects
    
    PlayerNumber
    
    Position
    
    PosX
    
    PosY
    
    SelectedStatusEffect
    
    StatusEffectHandler
    
    Threat
    
    ThreatMultiplier
  - Methods
    Methods
    
    AddForce
    
    AddGun
    
    AddPattern
    
    AddPhysicsForce
    
    AddStatus
    
    AdjustThreat
    
    ClearTrail
    
    Damage
    
    DropStatusEffects
    
    DuplicateActiveStatusEffects
    
    DuplicateRandomPassiveStatusEffect
    
    Get
    
    GetStatus
    
    GetStatusLevel
    
    HasStatus
    
    IsStatusSelected
    
    KillPlayer
    
    RemoveMainGun
    
    ReplaceMainGun
    
    ResetGunPositions
    
    ResetHitboxCore
    
    RestoreDefaultMainGun
    
    Revive
    
    SetFacingAngle
    
    SetHitboxCore
    
    SetPosition
    
    StartInvulnerability
    
    StatusEffectTrigger
    
    Vibrate
- Player_Behaviour
  Player_Behaviour
  - Player_Behaviour
- Player_Body
  Player_Body
  - Player_Body
  - Properties
    Properties
    
    BodyColorA
    
    BodyColorB
    
    BodyColorC
    
    BodyOpacity
    
    BrakePercent
    
    FacingAngle
    
    FacingDirection
    
    Size
    
    WidthMods
- Player_Camera
  Player_Camera
  - Player_Camera
- Player_Collision
  Player_Collision
  - Player_Collision
- Player_Crosshair
  Player_Crosshair
  - Player_Crosshair
- Player_Guns
  Player_Guns
  - Player_Guns
  - Properties
    Properties
    
    AimAngle
    
    AimDirection
    
    DefaultGun
    
    GunAimSpeedMultiplier
    
    GunTargetAngleAmount
    
    MaxRecoilPercent
    
    Position
    
    Size
    
    WidthMods
- Player_Health
  Player_Health
  - Player_Health
  - Properties
    Properties
    
    BulletDamageSource
    
    GrazePercent
    
    GrazePos
    
    InvulnPercent
    
    IsInvulnerable
    
    NumTimesPreventedDeath
    
    PlayerLastDamageSourceIsBullet
    
    UnitDamageSource
- Player_Hitbox
  Player_Hitbox
  - Player_Hitbox
  - Properties
    Properties
    
    Core
    
    Leniency
    
    Radius
- Player_Input
  Player_Input
  - Player_Input
  - Properties
    Properties
    
    ActivatePressed
    
    AimAngle
    
    AimDirection
    
    AimInputPercent
    
    AimVector
    
    BrakeInputPercent
    
    MoveDirection
    
    MoveInputPercent
    
    MoveVector
    
    ShootInputPercent
- Player_StatusEffects
  Player_StatusEffects
  - Player_StatusEffects
  - Properties
    Properties
    
    LastStatusActivatedPath
    
    LastStatusLevelChangedAmount
    
    LastStatusLevelChangedPath
    
    NumDroppableStatusEffects
    
    NumStatusEffects
    
    SelectedNum
    
    SelectedStatusEffect
    
    SelectedStatusPath
  - Methods
    Methods
    
    StatusEffectTrigger
- Player_Trail
  Player_Trail
  - Player_Trail
- Player_Vibration
  Player_Vibration
  - Player_Vibration
- PlayerActions
  PlayerActions
  - PlayerActions
- PlayerComponent
  PlayerComponent
  - PlayerComponent
- PlayerData
  PlayerData
  - PlayerData
  - Properties
    Properties
    
    Behaviour
    
    BodyAimSpeed
    
    BodyColorA
    
    BodyColorB
    
    BodyColorC
    
    BodyOffset
    
    BodyOpacity
    
    BodySize
    
    BodyWidthModifiers
    
    BulletGrazeSizeMultiplier
    
    BulletHitboxLeniency
    
    BulletPushPercent
    
    Camera
    
    CamLerpSpeed
    
    CamViewSize
    
    CorePath
    
    DeathTime
    
    DeathTimeScale
    
    DebugStatusEffects
    
    DebugText
    
    DebugVector
    
    DefaultGun
    
    HitboxLookDir
    
    HitboxLookPercent
    
    HitboxOpacity
    
    HitboxRadius
    
    HitVelocityDamping
    
    KeepStatusEffectsOnRevive
    
    KeyboardAimLerpSpeed
    
    KeyboardMoveLerpSpeed
    
    Movement
    
    PhysicsElements
    
    PixelAvoidStrength
    
    Properties
    
    RecoveryInvulnTime
    
    ResetTime
    
    ReverseAccelerationFactor
    
    RotateCoreSpeed
    
    SpriteIndex
    
    SpritePaths
    
    TrailColor
    
    TrailDistancePerPoint
    
    TrailMaxWidth
    
    TrailNumPoints
    
    TrailOffset
    
    TrailOpacityEasingType
    
    TrailRemovePointTime
    
    TrailWidthEasingType
    
    UseLegacySettings
  - Handlers
    Handlers
    
    OnActivateStatus
    
    OnChunkExplode
    
    OnDeathFinish
    
    OnDeathStart
    
    OnDisconnectChunk
    
    OnFixedUpdate
    
    OnHit
    
    OnHitBullet
    
    OnHitPixel
    
    OnHitPixelInvulnerable
    
    OnRevive
    
    OnSpawn
- PlayerData+CameraTargetData
  PlayerData+CameraTargetData
  - PlayerData+CameraTargetData
  - Properties
    Properties
    
    Center
    
    Condition
    
    Enforced
    
    Priority
    
    Radius
    
    Smoothness
- PlayerData+PlayerCameraData
  PlayerData+PlayerCameraData
  - PlayerData+PlayerCameraData
  - Properties
    Properties
    
    CameraTargets
    
    TargetViewArea
- PlayerGun
  PlayerGun
  - PlayerGun
  - Properties
    Properties
    
    IsActive
    
    RecoilPercent
  - Methods
    Methods
    
    SetPosition
- PlayerGunData
  PlayerGunData
  - PlayerGunData
  - Properties
    Properties
    
    BlockedByPixels
    
    BulletPattern
    
    ChargeAmountRequired
    
    ChargeDecay
    
    ChargeIncrease
    
    CollideWithPixels
    
    ColorA
    
    ColorB
    
    ColorC
    
    DebugText
    
    DebugVector
    
    DepthLevel
    
    FacingSpeed
    
    Inaccuracy
    
    OffsetAimSpeed
    
    OffsetDirection
    
    Opacity
    
    PositionLerpSpeed
    
    Properties
    
    RecoilForce
    
    RecoilTime
    
    ShouldShoot
    
    Size
    
    SpriteIndex
    
    SpritePaths
    
    TargetFacingDirection
    
    TargetPosition
    
    WidthModifiers
  - Handlers
    Handlers
    
    OnFixedUpdate
    
    OnSpawn
- PluginData
  PluginData
  - PluginData
  - Properties
    Properties
    
    Description
    
    Difficulty
    
    LeaderboardIndex
    
    PreviewImage
    
    Sounds
    
    Strings
    
    Tags
    
    Version
- ProgressBarMode
  ProgressBarMode
  - ProgressBarMode
- ProgressionManager
  ProgressionManager
  - ProgressionManager
  - Methods
    Methods
    
    GetAttempts
    
    GetCompletedCount
    
    GetDeaths
    
    GetMedal
    
    GetMedalCount
    
    GetMedalOrBetterCount
    
    GetStageCount
    
    GetVictories
    
    IsLevelCompleted
- PropertyContainerData
  PropertyContainerData
  - PropertyContainerData
  - Properties
    Properties
    
    Properties
- PropertyData
  PropertyData
  - PropertyData
- Pxc
  Pxc
  - Pxc
  - Properties
    Properties
    
    Unit
- PxcAnimData
  PxcAnimData
  - PxcAnimData
  - Properties
    Properties
    
    animTime
    
    compressed
    
    easingType
    
    framesInternal
    
    loopMode
- PxcAnimDataCompressed
  PxcAnimDataCompressed
  - PxcAnimDataCompressed
- PxcFrameData
  PxcFrameData
  - PxcFrameData
- PxcPixelImportData
  PxcPixelImportData
  - PxcPixelImportData
- PxcSourceData
  PxcSourceData
  - PxcSourceData
  - Properties
    Properties
    
    compressed
    
    GridHeight
    
    GridWidth
    
    pixelDataListInternal
- PxcSourceDataCompressed
  PxcSourceDataCompressed
  - PxcSourceDataCompressed
- RadialDirectionMode
  RadialDirectionMode
  - RadialDirectionMode
- Rand
  Rand
  - Rand
  - Methods
    Methods
    
    Chance
    
    Direction
    
    Flip
    
    Float
    
    Int
    
    PointInRect
    
    ShuffleArray
    
    Weighted
- RawJsonData
  RawJsonData
  - RawJsonData
- Repeat
  Repeat
  - Repeat
  - Properties
    Properties
    
    count
    
    delay
    
    inner
- ReplayActions
  ReplayActions
  - ReplayActions
- Rotation
  Rotation
  - Rotation
- RotationController
  RotationController
  - RotationController
  - Properties
    Properties
    
    CurrentAngle
- SampleFileData
  SampleFileData
  - SampleFileData
  - Properties
    Properties
    
    BeatsPerBar
    
    BeatsPerMinute
    
    ClipFileName
    
    Samples
- SampleFileData+SampleData
  SampleFileData+SampleData
  - SampleFileData+SampleData
  - Properties
    Properties
    
    LengthBars
    
    StartBar
    
    StartSeconds
- SetValue
  SetValue
  - SetValue
  - Properties
    Properties
    
    index
    
    name
    
    target
    
    type
- SfxIdent
  SfxIdent
  - SfxIdent
- SfxManifestData
  SfxManifestData
  - SfxManifestData
- ShapeType
  ShapeType
  - ShapeType
- SmallArenaCameraClampingMode
  SmallArenaCameraClampingMode
  - SmallArenaCameraClampingMode
- Song
  Song
  - Song
  - Properties
    Properties
    
    Bpm
- SongConfigData
  SongConfigData
  - SongConfigData
  - Properties
    Properties
    
    BeatsPerBar
    
    BeatsPerMinute
    
    Layers
    
    Properties
    
    RestartOnStageReset
- SongLayer
  SongLayer
  - SongLayer
  - Properties
    Properties
    
    HighPass
    
    LowPass
    
    Volume
- SongLayerData
  SongLayerData
  - SongLayerData
  - Properties
    Properties
    
    HighPass
    
    LowPass
    
    Segments
    
    Volume
- SongSegmentData
  SongSegmentData
  - SongSegmentData
  - Properties
    Properties
    
    HighPass
    
    LengthBars
    
    LowPass
    
    Name
    
    Next
    
    Sample
    
    Volume
  - Handlers
    Handlers
    
    Actions
- SpeedrunItem
  SpeedrunItem
  - SpeedrunItem
- SpriteAnimData
  SpriteAnimData
  - SpriteAnimData
- SpriteData
  SpriteData
  - SpriteData
  - Properties
    Properties
    
    anims
    
    gridHeight
    
    gridWidth
    
    spritesheetPath
- Stage
  Stage
- Stage_Background
  Stage_Background
  - Stage_Background
- Stage_Behaviour
  Stage_Behaviour
  - Stage_Behaviour
  - Properties
    Properties
    
    CurrentState
  - Methods
    Methods
    
    SetState
- Stage_Border
  Stage_Border
  - Stage_Border
- Stage_BulletPatterns
  Stage_BulletPatterns
  - Stage_BulletPatterns
- Stage_Bullets
  Stage_Bullets
  - Stage_Bullets
- Stage_Camera
  Stage_Camera
  - Stage_Camera
  - Methods
    Methods
    
    Shake
- Stage_CameraShake
  Stage_CameraShake
  - Stage_CameraShake
- Stage_DamageFloaters
  Stage_DamageFloaters
  - Stage_DamageFloaters
- Stage_Debug
  Stage_Debug
  - Stage_Debug
- Stage_DebugLines
  Stage_DebugLines
  - Stage_DebugLines
- Stage_Drawing
  Stage_Drawing
  - Stage_Drawing
- Stage_Entities
  Stage_Entities
  - Stage_Entities
- Stage_Fading
  Stage_Fading
  - Stage_Fading
- Stage_GameMode
  Stage_GameMode
  - Stage_GameMode
- Stage_Grid
  Stage_Grid
  - Stage_Grid
- Stage_Particles
  Stage_Particles
  - Stage_Particles
- Stage_Player
  Stage_Player
  - Stage_Player
  - Properties
    Properties
    
    AverageMoveInputPercent
    
    AverageShootInputPercent
  - Methods
    Methods
    
    GetClosestPlayer
    
    GetFirstExistingPlayer
    
    GetLastDyingPlayer
    
    GetRandomPlayerWeighted
    
    Vibrate
- Stage_Pooled
  Stage_Pooled
  - Stage_Pooled
- Stage_Scoring
  Stage_Scoring
  - Stage_Scoring
  - Properties
    Properties
    
    AllBossesDestroyed
    
    AllPlayersDead
    
    ElapsedTimeSeconds
    
    IsVictorious
    
    Progress
  - Methods
    Methods
    
    CalculateUnitsKilledProgress
    
    Defeat
    
    GameOver
    
    GetFormDestroyedTime
    
    GetFormStartProgress
    
    GetMedalValue
    
    Victory
- Stage_Song
  Stage_Song
  - Stage_Song
  - Properties
    Properties
    
    Song
- Stage_Speech
  Stage_Speech
  - Stage_Speech
  - Methods
    Methods
    
    SpawnBubble
- Stage_Sprites
  Stage_Sprites
  - Stage_Sprites
- Stage_Text
  Stage_Text
  - Stage_Text
  - Methods
    Methods
    
    DrawDebugText
- Stage_Timers
  Stage_Timers
  - Stage_Timers
- Stage_TimeScale
  Stage_TimeScale
  - Stage_TimeScale
  - Properties
    Properties
    
    CurrentTimeScale
  - Methods
    Methods
    
    AddFlatTimeScale
    
    AddTimeScale
    
    ClearTimeScales
- Stage_Units
  Stage_Units
  - Stage_Units
  - Properties
    Properties
    
    NumActiveUnits
- StageComponent
  StageComponent
  - StageComponent
- StageComponentBehaviour
  StageComponentBehaviour
  - StageComponentBehaviour
- StageData
  StageData
  - StageData
  - Properties
    Properties
    
    AllowBrakeHint
    
    Arena
    
    Behaviour
    
    CameraStageMargin
    
    ContinueWithStage
    
    DepthLevels
    
    Difficulty
    
    EnableBulletArchetypes
    
    GameMode
    
    LoadingTips
    
    LowPassDuringSlowMo
    
    Medals
    
    MergedTargetViewArea
    
    patternDebugText
    
    Player
    
    PlayerModes
    
    Properties
    
    Song
    
    SongTimeScale
    
    Units
  - Handlers
    Handlers
    
    OnFixedUpdate
    
    OnPlayerActivateStatus
    
    OnPlayerDie
    
    OnPlayerHit
    
    OnPlayerRevive
    
    OnPlayerStatusLevelChanged
    
    OnStart
- StageData+PlayerModeData
  StageData+PlayerModeData
  - StageData+PlayerModeData
  - Properties
    Properties
    
    Players
- StageID
  StageID
  - StageID
- StageMenuData
  StageMenuData
  - StageMenuData
  - Properties
    Properties
    
    AutoAssignMedalMultiplier
    
    AutoAssignMedals
    
    ContinueWithStage
    
    Core
    
    DefaultMedals
    
    Description
    
    EnableBulletArchetypes
    
    GameMode
    
    LoadingTips
    
    OverrideProgressSegments
    
    PlayerModes
    
    Song
    
    SpeedrunItems
    
    StageOverrideDirectories
    
    Subtitle
    
    Title
    
    Version
- StageMenuData+OverrideDirectory
  StageMenuData+OverrideDirectory
  - StageMenuData+OverrideDirectory
  - Properties
    Properties
    
    Destination
    
    Source
- StageMenuData+PlayerModeData
  StageMenuData+PlayerModeData
  - StageMenuData+PlayerModeData
  - Properties
    Properties
    
    _leaderboardCategory
    
    CameraMode
    
    CameraMode
    
    Medals
    
    Medals
    
    PlayerCount
    
    PlayerCount
    
    Subtitle
    
    Subtitle
- StageMenuData+StageUnitMenuData
  StageMenuData+StageUnitMenuData
  - StageMenuData+StageUnitMenuData
  - Properties
    Properties
    
    Config
- StagePlayerData
  StagePlayerData
  - StagePlayerData
- StageUnitData
  StageUnitData
  - StageUnitData
  - Properties
    Properties
    
    Config
    
    Count
    
    ProgressWeight
    
    RequiredForVictory
    
    Requirements
- StageUnitRequirementData
  StageUnitRequirementData
  - StageUnitRequirementData
- StatusEffect
  StatusEffect
  - StatusEffect
  - Properties
    Properties
    
    Charge
    
    ChargePercent
    
    ChargeRequired
    
    Description
    
    DoesPreventDeath
    
    ElapsedTime
    
    IsSelected
    
    Level
    
    NumLevels
    
    NumStatusBullets
    
    Player
    
    PreventDeathPriority
    
    ShortDescription
  - Methods
    Methods
    
    Activate
    
    AddBullet
    
    AddGun
    
    AddPattern
    
    ClearCharge
    
    DespawnAddedBullets
    
    DespawnAddedPatterns
    
    DespawnBullet
    
    DespawnFirstBullet
    
    DespawnGuns
    
    DespawnLastBullet
    
    Disable
    
    Execute
    
    Get
    
    LevelDown
    
    LevelUp
    
    NoLongerSelectable
    
    Select
    
    SetCharge
    
    Trigger
- StatusEffectCategoryData
  StatusEffectCategoryData
  - StatusEffectCategoryData
  - Properties
    Properties
    
    Color1
    
    Color2
    
    CornerRadius
- StatusEffectData
  StatusEffectData
  - StatusEffectData
  - Properties
    Properties
    
    AuxTexColor
    
    AuxText
    
    Behaviour
    
    Category
    
    ChargeAmountRequired
    
    ChargeDecay
    
    ChargeIncrease
    
    DebugText
    
    DebugVector
    
    Description
    
    DisplayName
    
    DoesPreventDeath
    
    DropStackLimit
    
    HideOnPauseMenu
    
    IconAngle
    
    IconColorBlinkTime
    
    IconFlipX
    
    IconFlipY
    
    IconPath
    
    IsDroppable
    
    IsSelectable
    
    Modifiers
    
    NumLevels
    
    PreventDeathPriority
    
    Properties
    
    ReplacesMainGun
    
    ShortDescription
    
    StaticDescription
    
    StaticName
  - Handlers
    Handlers
    
    OnActivate
    
    OnDeselect
    
    OnDisable
    
    OnEnable
    
    OnExecute
    
    OnFixedUpdate
    
    OnLevelDown
    
    OnLevelUp
    
    OnMaxedOut
    
    OnPlayerActivateStatus
    
    OnPlayerHit
    
    OnPlayerHitBullet
    
    OnPlayerRevive
    
    OnPreventDeath
    
    OnSelect
    
    OnTrigger
- StatusEffectPlayerModifierData
  StatusEffectPlayerModifierData
  - StatusEffectPlayerModifierData
  - Properties
    Properties
    
    BodyColorA
    
    BodyColorB
    
    BodyColorC
    
    BulletHitboxLeniencyFactor
    
    BulletPushPercentFactor
    
    DamageAmount
    
    FacingSpeedMultiplier
    
    FrictionMultiplier
    
    GunAimSpeedMultiplier
    
    GunTargetAngleAmount
    
    HitboxRadiusMultiplier
    
    IgnoreBulletDamage
    
    IgnoreLaserDamage
    
    Intangible
    
    LookSpeedPercent
    
    MoveSpeedMultiplier
    
    MoveSpeedMultiplierX
    
    MoveSpeedMultiplierY
    
    OpacityMultiplier
    
    ReverseControlsAmount
    
    ThreatMultiplier
    
    VelocityMultiplier
- StatusEffectUnitModifierData
  StatusEffectUnitModifierData
  - StatusEffectUnitModifierData
  - Properties
    Properties
    
    FacingSpeedMultiplier
    
    FrictionMultiplier
    
    Intangible
    
    MoveSpeedMultiplier
    
    OpacityMultiplier
    
    RotationSpeedMultiplier
    
    TargetPosLerpSpeedMultiplier
    
    TintBlendPercent
    
    TintColor
- SubroutineData
  SubroutineData
  - SubroutineData
  - Properties
    Properties
    
    Parameters
  - Handlers
    Handlers
    
    Actions
- Switch
  Switch
  - Switch
  - Properties
    Properties
    
    cases
    
    value
- Unit
  Unit
- Unit_Behaviour
  Unit_Behaviour
  - Unit_Behaviour
- Unit_Forms
  Unit_Forms
  - Unit_Forms
- Unit_StatusEffects
  Unit_StatusEffects
  - Unit_StatusEffects
  - Properties
    Properties
    
    NumStatusEffects
- UnitAnimData
  UnitAnimData
  - UnitAnimData
- UnitBorderWarningData
  UnitBorderWarningData
  - UnitBorderWarningData
  - Properties
    Properties
    
    Color
    
    DotFactorMin
    
    GlowEasing
    
    Opacity
    
    PosEasing
    
    Radius
    
    Range
- UnitComponent
  UnitComponent
  - UnitComponent
- UnitData
  UnitData
  - UnitData
  - Properties
    Properties
    
    Behaviour
    
    DebrisAmountMultiplier
    
    DebrisDragMultiplier
    
    DebrisLifetimeMultiplier
    
    DebrisSizeMultiplier
    
    DebrisSpeedMaxAddition
    
    DebrisSpeedMinAddition
    
    DebrisSpeedMultiplier
    
    debugText
    
    debugVector
    
    DepthLevel
    
    DisableOutOfBounds
    
    DontStopPatternsOnImplode
    
    DormantRange
    
    DormantUpdateInterval
    
    ExplosionPattern
    
    Forms
    
    HiddenColor
    
    IgnoreCollision
    
    IsStatic
    
    Movement
    
    OpacityLerpSpeed
    
    OverlapTransparencyPercent
    
    PhysicsElements
    
    ProgressWeight
    
    Properties
    
    PxcPrefix
    
    RemovedPartsDontStopPatterns
    
    RepelEffect
    
    SpawnInstantly
    
    StartFormNum
    
    TorqueFriction
    
    UseLegacySettings
  - Handlers
    Handlers
    
    OnChunkExplode
    
    OnDisable
- UnitFacingMode
  UnitFacingMode
  - UnitFacingMode
- UnitForm
  UnitForm
  - UnitForm
  - Methods
    Methods
    
    IsCharging
- UnitFormData
  UnitFormData
- UnitFormMenuData
  UnitFormMenuData
  - UnitFormMenuData
- UnitLaserData
  UnitLaserData
  - UnitLaserData
  - Properties
    Properties
    
    AimSpeed
    
    AnimSpeedOff
    
    AnimSpeedOn
    
    AutoRotate
    
    AutoRotateSpeed
    
    ClampToBounds
    
    ColorBlinkEasingType
    
    ColorBlinkTimeOff
    
    ColorBlinkTimeOn
    
    ColorOffA
    
    ColorOffB
    
    ColorOnA
    
    ColorOnB
    
    DamagePlayer
    
    Dps
    
    HitSelfPixels
    
    IgnoreCollisionWith
    
    IgnoreCollisionWithPaths
    
    ImpactPattern
    
    ImpactPatternDelay
    
    Length
    
    LengthLerpSpeed
    
    MissOffPattern
    
    MissOnPattern
    
    NumSegments
    
    OffsetDistance
    
    PartDamageFactor
    
    SetActiveAutomatically
    
    SfxHit
    
    SfxProximityOff
    
    SfxProximityOn
    
    StartAngle
    
    WidthAMax
    
    WidthAMin
    
    WidthBMax
    
    WidthBMin
  - Handlers
    Handlers
    
    OnHitPlayer
- UnitMenuData
  UnitMenuData
  - UnitMenuData
  - Properties
    Properties
    
    Forms
- UnitMovementData
  UnitMovementData
  - UnitMovementData
  - Properties
    Properties
    
    Acceleration
    
    FrictionPercentMax
    
    FrictionPercentMin
    
    Mass
    
    MaxSpeedLimit
    
    TopSpeed
- UnitMovementMode
  UnitMovementMode
  - UnitMovementMode
- UnitPartData
  UnitPartData
- UnitPartPlacementData
  UnitPartPlacementData
  - UnitPartPlacementData
- UnitPhysicsElementData
  UnitPhysicsElementData
  - UnitPhysicsElementData
  - Properties
    Properties
    
    FrictionPercentMax
    
    FrictionPercentMin
    
    MaxSpeedLimit
    
    TopSpeed
- UnitPixelJsonData
  UnitPixelJsonData
  - UnitPixelJsonData
  - Properties
    Properties
    
    Breakaway
    
    CantBeTransformed
    
    Category
    
    Color
    
    DamagedColor
    
    DamagePlayer
    
    DamageThreat
    
    DeathPattern
    
    DestroyVibrationStrength
    
    HitFlashTime
    
    HitGlow
    
    Hp
    
    IgnoreCollision
    
    IsAnchor
    
    IsSpawnSource
    
    NumDebris
    
    PixelType
    
    Range
    
    Ranges
    
    SfxDestroy
    
    SfxDisconnect
    
    SfxExplode
    
    SfxHit
    
    Tint
- UnitRepulsionCircleData
  UnitRepulsionCircleData
  - UnitRepulsionCircleData
  - Properties
    Properties
    
    Offset
    
    Radius
    
    Strength
- UnitShaderData
  UnitShaderData
  - UnitShaderData
  - Properties
    Properties
    
    DepthX
    
    DepthY
    
    FreqX
    
    FreqY
    
    Intensity
    
    SpeedX
    
    SpeedY
    
    TexturePath
    
    TimeFactor
    
    TimeFactor2
    
    TimeFactor3
- UnitStatusEffect
  UnitStatusEffect
  - UnitStatusEffect
  - Properties
    Properties
    
    Charge
    
    ChargePercent
    
    ChargeRequired
    
    ElapsedTime
    
    Level
    
    NumLevels
    
    NumStatusBullets
    
    Unit
  - Methods
    Methods
    
    AddBullet
    
    AddPattern
    
    ClearCharge
    
    DespawnAddedBullets
    
    DespawnAddedPatterns
    
    DespawnBullet
    
    DespawnFirstBullet
    
    DespawnLastBullet
    
    Disable
    
    Execute
    
    Get
    
    LevelDown
    
    LevelUp
    
    SetCharge
- UnitStatusEffectData
  UnitStatusEffectData
  - UnitStatusEffectData
  - Properties
    Properties
    
    Behaviour
    
    ChargeAmountRequired
    
    ChargeDecay
    
    ChargeIncrease
    
    DebugText
    
    DebugVector
    
    DisplayName
    
    Modifiers
    
    NumLevels
    
    Properties
  - Handlers
    Handlers
    
    OnDisable
    
    OnEnable
    
    OnExecute
    
    OnFixedUpdate
    
    OnLevelDown
    
    OnLevelUp
    
    OnMaxedOut
- UnitTextureData
  UnitTextureData
  - UnitTextureData
  - Properties
    Properties
    
    Shader
- Wait
  Wait
  - Wait
  - Properties
    Properties
    
    cantBeDelayed
    
    time
- Yield
  Yield
  - Yield
SpaceUsurper.Bullets
SpaceUsurper.Bullets
- BulletEntity
  BulletEntity
  - BulletEntity
- BulletJobs
  BulletJobs
  - BulletJobs
  - Methods
    Methods
    
    BumperUpdate
- BulletQueryData
  BulletQueryData
  - BulletQueryData
  - Properties
    Properties
    
    Exclude
    
    Include
    
    IncludePlayerBullets
- CircleData
  CircleData
  - CircleData
- DiamondData
  DiamondData
  - DiamondData
- RectData
  RectData
  - RectData
- TransformData
  TransformData
  - TransformData
SpaceUsurper.DamageFloaters
SpaceUsurper.DamageFloaters
- DamageFloaterData
  DamageFloaterData
  - DamageFloaterData
  - Properties
    Properties
    
    colorA
    
    colorB
    
    scale
SpaceUsurper.Services
SpaceUsurper.Services
- SortMethod
  SortMethod
  - SortMethod
SpaceUsurper.UI
SpaceUsurper.UI
- SpeechBubble
  SpeechBubble
  - SpeechBubble
  - Properties
    Properties
    
    TargetPlayer
  - Methods
    Methods
    
    Despawn
    
    DespawnAfter
    
    HideImmediate
    
    HideProgress
    
    ResetProgressBarColor
    
    SetBorderColor
    
    SetBorderWidth
    
    SetFillColor
    
    SetFont
    
    SetFontSize
    
    SetProgress
    
    SetProgressBarColor
    
    SetProgressFunc
    
    SetStyle
    
    SetTargetPlayer
    
    SetText
    
    SetTextColor
    
    Show

SongSegmentData.sample JsonProperty

Namespace: SpaceUsurper

Property Type: String

Copyright © 2022 Facepunch Studios LTD

powered by MkDocs and Material for MkDocs