Difference between revisions of "Script Parameters"

From Wolfire Games Wiki
Jump to: navigation, search
m (→‎Overview: Edited description; Added Link to Hotspots)
m (→‎Tables: Added type column; updated TODO: Add in a "type" column that shows what type of data the parameter takes and what the accepted values are.)
Line 7: Line 7:
 
Some parameters might not exist by default. If that's the case you simply need to press the "New parameter" button and type in the exact same name (including big/small letters).
 
Some parameters might not exist by default. If that's the case you simply need to press the "New parameter" button and type in the exact same name (including big/small letters).
  
−
'''TODO:''' Add in a "type" column that shows what type of data the parameter takes and what the accepted values are.
+
'''TODO:''' fill in type collumns.
  
 
== Level ==
 
== Level ==
Line 14: Line 14:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Parameter !! Description
+
! Parameter !! Type !! Description
 
|-
 
|-
 
! Achievements
 
! Achievements
 +
|
 
| Decide which challenges you can complete on the level, they appear on the level end screen.
 
| Decide which challenges you can complete on the level, they appear on the level end screen.
 
|-
 
|-
 
! Custom Shader
 
! Custom Shader
 +
|
 
| Here you can specify a list of shader defines (e.g. <code>'''#TEST_CLOUDS_2 #SNOW_EVERYWHERE'''</code> - [[Shader_And_Weather_Effects#Weather_Effects.2FWorld_Shaders|full list here]]) to change how the level is rendered.
 
| Here you can specify a list of shader defines (e.g. <code>'''#TEST_CLOUDS_2 #SNOW_EVERYWHERE'''</code> - [[Shader_And_Weather_Effects#Weather_Effects.2FWorld_Shaders|full list here]]) to change how the level is rendered.
 
|-
 
|-
 
! Fog amount
 
! Fog amount
 +
|
 
| Sets the thicknoess of the atmosphere and thus how far you can see.
 
| Sets the thicknoess of the atmosphere and thus how far you can see.
 
|-
 
|-
 
! GPU Particle Field
 
! GPU Particle Field
 +
|
 
| Here you can specify a list of shader defines (e.g. <code>'''#SNOW #MED'''</code> - [[Shader_And_Weather_Effects#Particles|full list here]]) to add global particle effects.
 
| Here you can specify a list of shader defines (e.g. <code>'''#SNOW #MED'''</code> - [[Shader_And_Weather_Effects#Particles|full list here]]) to add global particle effects.
 
|-
 
|-
 
! HDR Black point
 
! HDR Black point
 +
|
 
| Sets what brightness should be regarded as black.
 
| Sets what brightness should be regarded as black.
 
|-
 
|-
 
! HDR Bloom multiplier
 
! HDR Bloom multiplier
 +
|
 
| Decides how much light pixels bleed.
 
| Decides how much light pixels bleed.
 
|-
 
|-
 
! HDR White point
 
! HDR White point
 +
|
 
| Sets what brightness should be regarded as white.
 
| Sets what brightness should be regarded as white.
 
|-
 
|-
 
! Level Boundaries
 
! Level Boundaries
 +
|
 
| If this is checked characters will be pushed back into the level when they try to go past a certain point.
 
| If this is checked characters will be pushed back into the level when they try to go past a certain point.
 
|-
 
|-
 
! Objectives
 
! Objectives
 +
|
 
| Set the goal of the level.
 
| Set the goal of the level.
 
|-
 
|-
 
! Sky Brightness
 
! Sky Brightness
 +
|
 
| Adjust how bright the sky should be.
 
| Adjust how bright the sky should be.
 
|-
 
|-
 
! Sky Rotation
 
! Sky Rotation
 +
|
 
| Move the sky around.
 
| Move the sky around.
 
|-
 
|-
 
! Sky Tint
 
! Sky Tint
 +
|
 
| Makes the sky have a specified color.
 
| Makes the sky have a specified color.
 
|}
 
|}
Line 57: Line 69:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Parameter !! Description
+
! Parameter !! Type !! Description
 
|-
 
|-
 
! Attack Damage
 
! Attack Damage
 +
|
 
| The higher this is, the more health is taken from attacked characters.
 
| The higher this is, the more health is taken from attacked characters.
 
|-
 
|-
 
! Attack Knockback
 
! Attack Knockback
 +
|
 
| The higher this is, the more physics force is applied to attacked characters.
 
| The higher this is, the more physics force is applied to attacked characters.
 
|-
 
|-
 
! Attack Speed
 
! Attack Speed
 +
|
 
| The higher this is, the faster attack animations play.
 
| The higher this is, the faster attack animations play.
 
|-
 
|-
 
! Damage Resistance
 
! Damage Resistance
 +
|
 
| The higher this is, less health this character loses when it takes damage.
 
| The higher this is, less health this character loses when it takes damage.
 
|-
 
|-
 
! Knockout shield
 
! Knockout shield
 +
|
 
| How many times the character needs to lose their footing before they start taking real damage.
 
| How many times the character needs to lose their footing before they start taking real damage.
 
|-
 
|-
 
! Movement Speed
 
! Movement Speed
 +
|
 
| How fast the character moves when running.
 
| How fast the character moves when running.
 
|}
 
|}
Line 81: Line 99:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Parameter !! Description
+
! Parameter !! Type !! Description
 
|-
 
|-
 
! Aggression
 
! Aggression
 +
|
 
| How often this AI should attempt to attack.
 
| How often this AI should attempt to attack.
 
|-
 
|-
 
! Block Follow-up
 
! Block Follow-up
 +
|
 
| How often this AI should attempt a shoulder throw after blocking an attack.
 
| How often this AI should attempt a shoulder throw after blocking an attack.
 
|-
 
|-
 
! Block Skill
 
! Block Skill
 +
|
 
| How often this AI should block attacks.
 
| How often this AI should block attacks.
 
|-
 
|-
 
! Focus FOV distance
 
! Focus FOV distance
 +
|
 
| How far the AI can see, in meters.
 
| How far the AI can see, in meters.
 
|-
 
|-
 
! Focus FOV horizontal
 
! Focus FOV horizontal
 +
|
 
| How wide the AI's field of view is, in degrees.
 
| How wide the AI's field of view is, in degrees.
 
|-
 
|-
 
! Focus FOV vertical
 
! Focus FOV vertical
 +
|
 
| How tall the AI's field of view is, in degrees.
 
| How tall the AI's field of view is, in degrees.
 
|-
 
|-
 
! Peripheral FOV distance
 
! Peripheral FOV distance
 +
|
 
| How far the AI can see in its close proximity, in meters.
 
| How far the AI can see in its close proximity, in meters.
 
|-
 
|-
 
! Peripheral FOV horizontal
 
! Peripheral FOV horizontal
 +
|
 
| How wide the AI's near field of view is, in degrees.
 
| How wide the AI's near field of view is, in degrees.
 
|-
 
|-
 
! Peripheral FOV vertical
 
! Peripheral FOV vertical
 +
|
 
| How tall the AI's near field of view is, in degrees.
 
| How tall the AI's near field of view is, in degrees.
 
|-
 
|-
 
! Ground Aggression
 
! Ground Aggression
 +
|
 
| How often the AI should attack an opponent that's ragdolled.
 
| How often the AI should attack an opponent that's ragdolled.
 
|-
 
|-
 
! Hearing Modifier
 
! Hearing Modifier
 +
|
 
| A multiplier for the distance at which that sounds can be heard.
 
| A multiplier for the distance at which that sounds can be heard.
 
|-
 
|-
 
! scared
 
! scared
 +
|
 
| Makes the AI run away from enemies.
 
| Makes the AI run away from enemies.
 
|-
 
|-
 
! Stick To Nav Mesh
 
! Stick To Nav Mesh
 +
|
 
| Removes physics calculations for this NPC's movement to ensure they do not fall off cliffs etc.
 
| Removes physics calculations for this NPC's movement to ensure they do not fall off cliffs etc.
 
|-
 
|-
 
! Throw Counter Probability
 
! Throw Counter Probability
 +
|
 
| Disables this NPC's ability to block shoulder throws.
 
| Disables this NPC's ability to block shoulder throws.
 
|-
 
|-
 
! Throw Trainer
 
! Throw Trainer
 +
|
 
| Changes sound when shoulder throwing this character. If tutorials are on, it also makes the character invulnerable to jump kicks, makes them block all attacks, and sets their health really low when their KO shield is gone. This is used on the first enemy in the "Slaver Path" level in the Overgrowth story.
 
| Changes sound when shoulder throwing this character. If tutorials are on, it also makes the character invulnerable to jump kicks, makes them block all attacks, and sets their health really low when their KO shield is gone. This is used on the first enemy in the "Slaver Path" level in the Overgrowth story.
 
|-
 
|-
 
! Weapon Catch Skill
 
! Weapon Catch Skill
 +
|
 
| Changes the NPC's ability to grab thrown weapons in the air.
 
| Changes the NPC's ability to grab thrown weapons in the air.
 
|}
 
|}
Line 137: Line 171:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Parameter !! Description
+
! Parameter !! Type !! Description
 
|-
 
|-
 
! Character Scale
 
! Character Scale
 +
|
 
| The higher this is, the bigger the character is.
 
| The higher this is, the bigger the character is.
 
|-
 
|-
 
! Ear Size
 
! Ear Size
 +
|
 
| How big the ears are.
 
| How big the ears are.
 
|-
 
|-
 
! Fat
 
! Fat
 +
|
 
| How heavy the character is.
 
| How heavy the character is.
 
|-
 
|-
 
! Left handed
 
! Left handed
 +
|
 
| If checked, the character uses weapons in their left hand instead of their right hand.
 
| If checked, the character uses weapons in their left hand instead of their right hand.
 
|-
 
|-
 
! Muscle
 
! Muscle
 +
|
 
| How bulky the character is.
 
| How bulky the character is.
 
|}
 
|}
Line 158: Line 197:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Parameter !! Description
+
! Parameter !! Type !! Description
 
|-
 
|-
 
! Cannot Be Disarmed
 
! Cannot Be Disarmed
 +
|
 
| If checked, this character cannot have its weapon taken away.
 
| If checked, this character cannot have its weapon taken away.
 
|-
 
|-
 
! Static
 
! Static
 +
|
 
| If checked, this character can't move and has no AI.
 
| If checked, this character can't move and has no AI.
 
|-
 
|-
 
! Teams
 
! Teams
 +
|
 
| All characters that share at least one team can't attack each other. A character can be on more than one team if you just separate them by commas, for example <code>team1, team2, team3</code>
 
| All characters that share at least one team can't attack each other. A character can be on more than one team if you just separate them by commas, for example <code>team1, team2, team3</code>
 
|}
 
|}

Revision as of 21:02, 7 March 2018

This page covers non-hotspot object script parameters only. For hotspot specific script parameters, see Hotspots.

Script parameters can be set per object (and Level) and are used to pass parameters to an underlying script.

The script parameters for the selected object can be most easily changed using the selected window.

Some parameters might not exist by default. If that's the case you simply need to press the "New parameter" button and type in the exact same name (including big/small letters).

TODO: fill in type collumns.

Level

The level parameters can be accessed by bringing up the scenegraph window, expanding "Level" at the top, and then "Script Params".

Parameter Type Description
Achievements Decide which challenges you can complete on the level, they appear on the level end screen.
Custom Shader Here you can specify a list of shader defines (e.g. #TEST_CLOUDS_2 #SNOW_EVERYWHERE - full list here) to change how the level is rendered.
Fog amount Sets the thicknoess of the atmosphere and thus how far you can see.
GPU Particle Field Here you can specify a list of shader defines (e.g. #SNOW #MED - full list here) to add global particle effects.
HDR Black point Sets what brightness should be regarded as black.
HDR Bloom multiplier Decides how much light pixels bleed.
HDR White point Sets what brightness should be regarded as white.
Level Boundaries If this is checked characters will be pushed back into the level when they try to go past a certain point.
Objectives Set the goal of the level.
Sky Brightness Adjust how bright the sky should be.
Sky Rotation Move the sky around.
Sky Tint Makes the sky have a specified color.

Character

Stats

Parameter Type Description
Attack Damage The higher this is, the more health is taken from attacked characters.
Attack Knockback The higher this is, the more physics force is applied to attacked characters.
Attack Speed The higher this is, the faster attack animations play.
Damage Resistance The higher this is, less health this character loses when it takes damage.
Knockout shield How many times the character needs to lose their footing before they start taking real damage.
Movement Speed How fast the character moves when running.

AI

Parameter Type Description
Aggression How often this AI should attempt to attack.
Block Follow-up How often this AI should attempt a shoulder throw after blocking an attack.
Block Skill How often this AI should block attacks.
Focus FOV distance How far the AI can see, in meters.
Focus FOV horizontal How wide the AI's field of view is, in degrees.
Focus FOV vertical How tall the AI's field of view is, in degrees.
Peripheral FOV distance How far the AI can see in its close proximity, in meters.
Peripheral FOV horizontal How wide the AI's near field of view is, in degrees.
Peripheral FOV vertical How tall the AI's near field of view is, in degrees.
Ground Aggression How often the AI should attack an opponent that's ragdolled.
Hearing Modifier A multiplier for the distance at which that sounds can be heard.
scared Makes the AI run away from enemies.
Stick To Nav Mesh Removes physics calculations for this NPC's movement to ensure they do not fall off cliffs etc.
Throw Counter Probability Disables this NPC's ability to block shoulder throws.
Throw Trainer Changes sound when shoulder throwing this character. If tutorials are on, it also makes the character invulnerable to jump kicks, makes them block all attacks, and sets their health really low when their KO shield is gone. This is used on the first enemy in the "Slaver Path" level in the Overgrowth story.
Weapon Catch Skill Changes the NPC's ability to grab thrown weapons in the air.

TODO: Exactly how does focus/peripheral FOV work?

Visual

Parameter Type Description
Character Scale The higher this is, the bigger the character is.
Ear Size How big the ears are.
Fat How heavy the character is.
Left handed If checked, the character uses weapons in their left hand instead of their right hand.
Muscle How bulky the character is.

Other

Parameter Type Description
Cannot Be Disarmed If checked, this character cannot have its weapon taken away.
Static If checked, this character can't move and has no AI.
Teams All characters that share at least one team can't attack each other. A character can be on more than one team if you just separate them by commas, for example team1, team2, team3
Retrieved from "https://wiki.wolfire.com/index.php?title=Script_Parameters&oldid=5705"