math_shared.csc File Reference

Go to the source code of this file.

Functions
function	angle_dif (oldangle, newangle)
function	array_average (array)
function	array_std_deviation (array, mean)
function	clamp (val, val_min, val_max)
function	cointoss ()
function	lag (desired, curr, k, dt)
function	linear_map (num, min_a, max_a, min_b, max_b)
function	random_vector (max_length)
function	sign (x)
function	vector_compare (vec1, vec2)

Function Documentation

angle_dif()

function angle_dif	(	oldangle	,
		newangle
	)

Definition at line 154 of file math_shared.csc.

array_average()

function array_average

(

array

)

Description:
"Function Name: array_average( <array> )"
"Summary: Given an array of numbers, returns the average (mean) value of the array" "Module: Utility"
"Mandatory Argument(s): <array>: the array of numbers which will be averaged"
"Example:array_average( numbers );"
"Single Player / Multi Player: both"

Definition at line 86 of file math_shared.csc.

References array.

Referenced by set_rank().

array_std_deviation()

function array_std_deviation	(	array	,
		mean
	)

Description:
"Function Name: array_std_deviation( <array>, <mean> )"
"Summary: Given an array of numbers and the average of the array, returns the standard deviation value of the array" "Module: Utility"
"Mandatory Argument(s): <array>: the array of numbers"
"Mandatory Argument(s): <mean>: the average (mean) value of the array"
"Example:array_std_deviation( numbers, avg );"
"Single Player / Multi Player: both"

Definition at line 111 of file math_shared.csc.

References array.

Referenced by set_rank().

clamp()

function clamp	(	val	,
		val_min	,
		val_max
	)

Description:
"Function Name: clamp(val, val_min, val_max)"
"Summary: Clamps a value between a min and max value." "Module: Math"
"Mandatory Argument(s): val: the value to clamp."
"Mandatory Argument(s): val_min: the min value to clamp to."
"Mandatory Argument(s): val_max: the mac value to clamp to."
"Example:clamped_val = clamp(8, 0, 5); // returns 5 * clamped_val = clamp(-1, 0, 5); // returns 0"
"Single Player / Multi Player: both"

Definition at line 16 of file math_shared.csc.

Referenced by _setPlayerMomentum(), _setTeamScore(), _temp_dialog(), actorCharRampTo(), Attack_Thread_Rocket(), calc_ramp_in_lerp(), calc_remaining_duration_lerp(), continue_draining_hero_weapon(), croc_find_new_position(), default_getTimeLimit(), fx_think(), get_locomotion_target(), GetNextMovePosition_evasive(), gravityspikes_power_override(), RobotPhalanx::Initialize(), Phalanx::Initialize(), linear_map(), metalstorm_find_new_position(), MonitorDistance(), Movement_Thread_Wander(), nudge_collision(), player_drown_fx(), player_hero_power_event(), registerNumLives(), registerRoundLimit(), registerRoundScoreLimit(), registerRoundSwitch(), registerRoundWinLimit(), registerScoreLimit(), registerTimeLimit(), set_rank(), setLightArmorHP(), setPointsToWin(), SetStage(), should_update_damage_fx_level(), timeout_beep(), update_current_progress(), update_damage_as_occupant(), updateGameTypeDvars(), UpdatePlayerDamage(), and UpdateTrait().

cointoss()

function cointoss

(

)

Definition at line 171 of file math_shared.csc.

Referenced by _tryGibbingLegs(), _tryGibbingLimb(), apothiconKnockdownZombie(), calculateCoverDirection(), calculateJukeDirection(), getBestSpawnPoint(), humanGibKilledOverride(), mechzBerserkKnockdownService(), octo_gib(), player_revive_monitor(), projectile_find_target(), projectile_find_target_killstreak(), projectile_find_target_player(), projectile_spawn(), RandomGibRogueRobot(), razKnockdownZombies(), result(), robotExplodeTerminate(), robotForceCrawler(), robotGibDeathOverride(), robotSoldierSpawnSetup(), sentinel_CallbackDamage(), sentinel_DodgeRoll(), sentinel_drone_CallbackRadiusDamage(), setup_zombie_knockdown(), side_step(), start_explosive_ragdoll(), stepOutInitialize(), thrasherKnockdownZombie(), TryGibbingLegs(), TryGibbingLimb(), wait_till_something_happens(), zombie_death_gib(), zombie_faller_do_fall(), zombie_slam_direction(), and zombieJuke().

lag()

function lag	(	desired	,
		curr	,
		k	,
		dt
	)

Description:
"Function Name: lag(desired, curr, k, dt)"
"Summary: Changes a value from current to desired using 1st order differential lag." "Module: Math"
"Mandatory Argument(s): desired: desired value."
"Mandatory Argument(s): curr: the current value."
"Mandatory Argument(s): k: the strength of the lag ( lower = slower, higher = faster)."
"Mandatory Argument(s): dt: time step to lag over ( usually 1 server frame )."
"Example:speed = lag(max_speed, speed, 1, 0.05);"
"Single Player / Multi Player: both"

Definition at line 60 of file math_shared.csc.

linear_map()

function linear_map	(	num	,
		min_a	,
		max_a	,
		min_b	,
		max_b
	)

Description:
"Function Name: linear_map(val, min_a, max_a, min_b, max_b)"
"Summary: Maps a value within one range to a value in another range." "Module: Math"
"Mandatory Argument(s): val: the value to map."
"Mandatory Argument(s): min_a: the min value of the range in which <val> exists."
"Mandatory Argument(s): max_a: the max value of the range in which <val> exists."
"Mandatory Argument(s): min_b: the min value of the range in which the return value should exist."
"Mandatory Argument(s): max_b: the max value of the range in which the return value should exist."
"Example:fov = linear_map(speed, min_speed, max_speed, min_fov, max_fov);"
"Single Player / Multi Player: both"

Definition at line 43 of file math_shared.csc.

References clamp().

Referenced by electric_cherry_reload_attack(), and pulse_damage().

random_vector()

function random_vector

(

max_length

)

Definition at line 149 of file math_shared.csc.

sign()

function sign

(

x

)

Definition at line 164 of file math_shared.csc.

Referenced by barrel_rolling_crash(), helicopter_crash_movement(), helicopter_crash_zone_accel(), hunter_pain_small(), MissileTarget_DeployFlares(), nudge_collision(), plane_crash(), QRDrone_crash_movement(), quadrotor_crash_movement(), random_crash(), throw_off_balance(), trackLoop(), and watchCheckpointTrigger().

vector_compare()

function vector_compare	(	vec1	,
		vec2
	)

Description:
"Function Name: vector_compare( <vec1>, <vec2> )"
"Summary: For 3D vectors. Returns true if the vectors are the same"
"Mandatory Argument(s): <vec1> : A 3D vector (origin)"
"Mandatory Argument(s): <vec2> : A 3D vector (origin)"
"Example:if (vector_compare(self.origin, node.origin){print(\"yay, i'm on the node!");}" <br/>"Single Player / Multi Player: both"

Definition at line 144 of file math_shared.csc.