ig.CONFIG.

CHARACTER

Character base configuration settings. IMPORTANT: Don't modify config directly! (see example)

Author:
  • Collin Hover - collinhover.com
Source:
// in order to add your own custom configuration to Impact++
// edit the file defining ig.CONFIG_USER, 'plusplus.config-user'
// ig.CONFIG_USER is never modified by Impact++ (it is strictly for your use)
// ig.CONFIG_USER is automatically merged over Impact++'s config

Members

<static> ANIM_AUTOMATIC :Boolean

Whether character is allowed to set own ig.EntityExtended#currentAnim automatically based on current state.

Default Value:
  • true
Source:

<static> CAN_CLIMB :Boolean

Whether character is able to climb.

Default Value:
  • true
Source:

<static> CAN_JUMP :Boolean

Whether character is able to jump.

Default Value:
  • true
Source:

<static> CAN_PATHFIND :Boolean

Whether character is able to pathfind.

Default Value:
  • true
Source:

<static> CLIMBING_CONTROL :Number

Amount of acceleration control while climbing.

Default Value:
  • 1
Source:
Example 
// no control of direction while climbing
character.climbingControl = 0;
// full control of direction while climbing
character.climbingControl = 1;

<static> ENERGY :Number

Energy statistic, by default used in abilities.

Default Value:
  • 1
Source:

<static> EXPLODING_DAMAGE :Boolean

Whether characters should have a particle explosion when damaged.
- explosions are created through an ig.EntityExplosion

Default Value:
  • true
Source:

<static> EXPLODING_DAMAGE_PARTICLE_COUNT :Number

Number of particles to create for explosion when character damaged.

Default Value:
  • 3
Source:

<static> EXPLODING_DEATH :Boolean

Characters should have a particle explosion when killed.
- explosions are created through an ig.EntityExplosion

Default Value:
  • true
Source:

<static> EXPLODING_DEATH_PARTICLE_COUNT :Number

Number of particles to create for explosion when character killed.

Default Value:
  • 10
Source:

<static> FRICTION_GROUNDED_X :Number

Horizontal friction while on ground.

Default Value:
  • 1600
Source:

<static> FRICTION_GROUNDED_Y :Number

Vertical friction while on ground.

Default Value:
  • 1600
Source:

<static> FRICTION_UNGROUNDED_X :Number

Horizontal friction while in air.

Default Value:
  • 0
Source:

<static> FRICTION_UNGROUNDED_Y :Number

Vertical friction while in air.

Default Value:
  • 0
Source:

<static> HEALTH :Number

Health statistic.

Default Value:
  • 1
Source:

<static> JUMP_CONTROL :Number

Amount of acceleration control while in air.

Default Value:
  • 0.75
Source:
Example 
// no control of direction while in air
character.jumpControl = 0;
// full control of direction while in air
character.jumpControl = 1;

<static> JUMP_FORCE :Number

Speed modifier to apply on each jump step.

Default Value:
  • 10
Source:
Example 
// jump is slow and not very high
character.jumpForce = 1;
// jump is faster and higher
character.jumpForce = 10;

<static> JUMP_STEPS :Number

Number of update steps to apply jump force.

Default Value:
  • 4
Source:
Example 
// jump is short
character.jumpSteps = 1;
// jump is long
character.jumpSteps = 10;

<static> MAX_VEL_CLIMBING_X :Number

Max x velocity while climbing.

Default Value:
  • 75
Source:

<static> MAX_VEL_CLIMBING_Y :Number

Max y velocity while climbing.

Default Value:
  • 75
Source:

<static> MAX_VEL_GROUNDED_X :Number

Max x velocity while on ground.

Default Value:
  • 100
Source:

<static> MAX_VEL_GROUNDED_Y :Number

Max y velocity while on ground.

Default Value:
  • 100
Source:

<static> MAX_VEL_UNGROUNDED_X :Number

Max x velocity while in air.

Default Value:
  • 100
Source:

<static> MAX_VEL_UNGROUNDED_Y :Number

Max y velocity while in air.

Default Value:
  • 200
Source:

<static> PATHFINDING_DELAY :Number

Delay in seconds between pathfinding when has no path. IMPORTANT: setting this to a low value may cause a high number of pathfinding requests, which can be performance intensive!

Default Value:
  • 1
Source:

<static> PATHFINDING_SIMPLE_DELAY :Number

Delay in seconds between pathfinding when using simple pathfinding. Tip: the faster an entity is, the lower this value needs to be for smooth simple pathfinding. Currently it is tuned for the default Impact++ settings.

Default Value:
  • 0.075
Source:

<static> PATHFINDING_UPDATE_DELAY :Number

Delay in seconds between pathfinding when following a path. IMPORTANT: setting this to a low value may cause a high number of pathfinding requests, which can be performance intensive!

Default Value:
  • 0.2
Source:

<static> REGEN_RATE_ENERGY :Number

Amount of energy a character should regenerate per tick.

Default Value:
  • 0
Source:

<static> REGEN_RATE_HEALTH :Number

Amount of health a character should regenerate per tick.

Default Value:
  • 0
Source:

<static> SIZE_OFFSET_X :Number

Horizontal offset of characters allows visual overlap with walls to give some depth.

Default Value:
  • 0
Source:

<static> SIZE_OFFSET_Y :Number

Vertical offset of characters allows visual overlap with floor / ceiling to give some depth.

Default Value:
  • 0
Source:

<static> SIZE_X :Number

Base horizontal size of characters that can also affect many calculations, ex: melee ability distance.

Default Value:
  • 32
Source:

<static> SIZE_Y :Number

Base vertical size of characters that can also affect many calculations, ex: melee ability distance.

Default Value:
  • 32
Source:

<static> SPEED_X :Number

Movement speed applied to horizontal acceleration.

Default Value:
  • 750
Source:

<static> SPEED_Y :Number

Movement speed applied to vertical acceleration.

Default Value:
  • 750
Source:

<static> STUCK_DELAY :Number

Delay in seconds, after first becoming stuck, when character will throw path away. IMPORTANT: for best results, this should be less than ig.Character#pathfindingUpdateDelay.

Default Value:
  • 0.1
Source:

<static> UNGROUNDED_FOR_AND_FALLING_THRESHOLD :Number

Duration after character leaves ground to start playing fall animation.

Default Value:
  • 0.25
Source:

<static> UNGROUNDED_FOR_THRESHOLD :Number

Duration after character leaves ground during which they can still jump.
- this is intended to help players with slower reaction time
- this does not allow another jump while jumping

Default Value:
  • 0.1
Source: