Macros
#define	GROUND_HEIGHT 5

Functions
function	__init__ ()

function private	_init_rider (vh, str_pos)

function private	_unclaim_position_on_death (vh, str_pos)

function	can_get_in (vh, str_pos)

function	claim_position (vh, str_pos)

function	delete_rider_asap (entity)

function	exit_ground ()

function	exit_high_loop_anim (e_parent)

function	exit_low ()

function	exit_variable ()

function	find_next_open_position (ai)

function private	forward_euler_integration (e_move, v_target_landing, n_initial_speed)

function	get_bundle ()

function	get_bundle_for_ai (ai)

function	get_height (e_ignore)

function	get_in (vh, str_pos, b_teleport=false)

function	get_out (str_mode)

function	get_rider (str_pos)

function	get_rider_info (vh, str_pos="driver")

function	get_robot_bundle ()

function private	handle_falling_death ()

function	handle_rider_death ()

function	is_seat_available (vh, str_pos)

function	kill_rider (entity)

function	on_ai_spawned ()

function	on_vehicle_killed (params)

function	on_vehicle_spawned ()

function	ragdoll_dead_exit_rider ()

function	remove_riders_after_wait (wait_time, a_riders_to_remove)

function	seat_position_to_index (str_position)

function	set_goal ()

function	spawn_riders ()

function	unclaim_position (vh, str_pos)

function	unload (str_group="all", str_mode, remove_rider_before_unloading, remove_riders_wait_time)

Macro Definition Documentation

◆ GROUND_HEIGHT

#define GROUND_HEIGHT 5

Definition at line 472 of file vehicleriders_shared.gsc.

Function Documentation

◆ init()

function __init__ ( )

Definition at line 35 of file vehicleriders_shared.gsc.

References add(), DEFAULT, get_script_bundles(), on_ai_spawned(), on_vehicle_killed(), on_vehicle_spawned(), register(), and VERSION_SHIP.

◆ _init_rider()

function private _init_rider	(	vh	,
		str_pos
	)

Definition at line 842 of file vehicleriders_shared.gsc.

References DEFAULT, and get_rider_info().

Referenced by get_in().

◆ _unclaim_position_on_death()

function private _unclaim_position_on_death	(	vh	,
		str_pos
	)

Definition at line 137 of file vehicleriders_shared.gsc.

References unclaim_position().

Referenced by claim_position().

◆ can_get_in()

function can_get_in	(	vh	,
		str_pos
	)

Definition at line 450 of file vehicleriders_shared.gsc.

References get_rider_info(), and is_seat_available().

Referenced by _turret_new_user_think().

◆ claim_position()

function claim_position	(	vh	,
		str_pos
	)

Definition at line 121 of file vehicleriders_shared.gsc.

References _unclaim_position_on_death(), add(), and set().

Referenced by get_in().

◆ delete_rider_asap()

function delete_rider_asap ( entity )

Definition at line 371 of file vehicleriders_shared.gsc.

References SERVER_FRAME.

Referenced by kill_rider().

◆ exit_ground()

function exit_ground ( )

Definition at line 640 of file vehicleriders_shared.gsc.

References play(), ragdoll_dead_exit_rider(), and set_death_anim().

Referenced by get_out().

◆ exit_high_loop_anim()

function exit_high_loop_anim ( e_parent )

Definition at line 784 of file vehicleriders_shared.gsc.

References play().

Referenced by exit_variable().

◆ exit_low()

function exit_low ( )

Definition at line 657 of file vehicleriders_shared.gsc.

References play(), and set_death_anim().

Referenced by get_out().

◆ exit_variable()

function exit_variable ( )

Definition at line 714 of file vehicleriders_shared.gsc.

References exit_high_loop_anim(), forward_euler_integration(), get_bundle_for_ai(), get_height(), handle_falling_death(), IS_TRUE, play(), set_death_anim(), spawn_model(), and WAIT_SERVER_FRAME.

Referenced by get_out().

◆ find_next_open_position()

function find_next_open_position ( ai )

Definition at line 147 of file vehicleriders_shared.gsc.

References get(), get_bundle_for_ai(), and seat_position_to_index().

Referenced by get_in().

◆ forward_euler_integration()

function private forward_euler_integration	(	e_move	,
		v_target_landing	,
		n_initial_speed
	)

Definition at line 677 of file vehicleriders_shared.gsc.

References waitTillHostMigrationDone().

Referenced by exit_variable().

◆ get_bundle()

function get_bundle ( )

Definition at line 805 of file vehicleriders_shared.gsc.

References get_script_bundle().

Referenced by get_bundle_for_ai().

◆ get_bundle_for_ai()

function get_bundle_for_ai ( ai )

Definition at line 187 of file vehicleriders_shared.gsc.

References get_bundle(), get_robot_bundle(), and IS_ROBOT.

Referenced by exit_variable(), find_next_open_position(), get_out(), and get_rider_info().

◆ get_height()

function get_height ( e_ignore )

Definition at line 795 of file vehicleriders_shared.gsc.

References DEFAULT, and trace().

Referenced by exit_variable().

◆ get_in()

function get_in	(	vh	,
		str_pos	,
		b_teleport	= `false`
	)

Description:

"Summary: Makes an AI get in a vehicle (with animation)" "Function Name: get_in( vh, str_pos, b_teleport = false )" "CallOn: AI"
"Mandatory Argument(s): <vh> The vehicle to ride in"
"Optional Argument(s): [str_pos] The position to ride in. If undefined, will choose next available position."
"Optional Argument(s): [b_teleport] If true, teleport to rider position and don't play get in animation."
"Example:ai vehicle::get_in( vh_truck, "driver" );"

Definition at line 226 of file vehicleriders_shared.gsc.

References _init_rider(), claim_position(), disable(), find_next_open_position(), get(), get_out(), handle_rider_death(), increment(), is_color_ai(), play(), reach(), set(), and set_death_anim().

Referenced by _turret_new_user_think(), Prolog(), and spawn_riders().

◆ get_out()

function get_out ( str_mode )

Description:

"Summary: Makes an AI get out of a vehicle (with animation)" "Function Name: get_out()" "CallOn: AI"
"Example:ai vehicle::get_out();"

Definition at line 481 of file vehicleriders_shared.gsc.

References clear(), DEFAULT, exit_ground(), exit_low(), exit_variable(), get(), get_bundle_for_ai(), increment(), IS_HELICOPTER, IS_PLANE, set_death_anim(), set_goal(), and unclaim_position().

Referenced by _drop_turret(), get_in(), and unload().

◆ get_rider()

function get_rider ( str_pos )

Description:

"Summary: Get a specific rider from a vehicle. Look at vehiclerider GDT for possible positions." "Function Name: get_rider( str_pos )" "CallOn: Vehicle"
"Mandatory Argument(s): <str_group> The rider position to unload."
"Example:ai_rider = vh_truck vehicle::get_rider( "passenger1" );"

Definition at line 825 of file vehicleriders_shared.gsc.

◆ get_rider_info()

function get_rider_info	(	vh	,
		str_pos	= `"driver"`
	)

Definition at line 201 of file vehicleriders_shared.gsc.

References get_bundle_for_ai().

Referenced by _init_rider(), and can_get_in().

◆ get_robot_bundle()

function get_robot_bundle ( )

Definition at line 811 of file vehicleriders_shared.gsc.

References get_script_bundle().

Referenced by get_bundle_for_ai().

◆ handle_falling_death()

function private handle_falling_death ( )

Definition at line 664 of file vehicleriders_shared.gsc.

Referenced by exit_variable().

◆ handle_rider_death()

function handle_rider_death ( )

Definition at line 347 of file vehicleriders_shared.gsc.

References increment(), and set_death_anim().

Referenced by get_in().

◆ is_seat_available()

function is_seat_available	(	vh	,
		str_pos
	)

Definition at line 426 of file vehicleriders_shared.gsc.

References get(), and seat_position_to_index().

Referenced by can_get_in().

◆ kill_rider()

function kill_rider ( entity )

Definition at line 381 of file vehicleriders_shared.gsc.

References Annihilate(), delete_rider_asap(), GIB_ANNIHILATE_FLAG, GibLeftArm(), GibLegs(), GibRightArm(), IsGibbed(), and stop_magic_bullet_shield().

Referenced by on_vehicle_killed().

◆ on_ai_spawned()

function on_ai_spawned ( )

Definition at line 113 of file vehicleriders_shared.gsc.

References spawn_riders().

Referenced by __init__().

◆ on_vehicle_killed()

function on_vehicle_killed ( params )

Definition at line 413 of file vehicleriders_shared.gsc.

References kill_rider().

Referenced by __init__().

◆ on_vehicle_spawned()

function on_vehicle_spawned ( )

Definition at line 108 of file vehicleriders_shared.gsc.

References spawn_riders().

Referenced by __init__().

◆ ragdoll_dead_exit_rider()

function ragdoll_dead_exit_rider ( )

Definition at line 627 of file vehicleriders_shared.gsc.

Referenced by exit_ground().

◆ remove_riders_after_wait()

function remove_riders_after_wait	(	wait_time	,
		a_riders_to_remove
	)

Definition at line 614 of file vehicleriders_shared.gsc.

Referenced by unload().

◆ seat_position_to_index()

function seat_position_to_index ( str_position )

Definition at line 103 of file vehicleriders_shared.gsc.

Referenced by find_next_open_position(), and is_seat_available().

◆ set_goal()

function set_goal ( )

Definition at line 563 of file vehicleriders_shared.gsc.

References enable(), and is_color_ai().

Referenced by get_out().

◆ spawn_riders()

function spawn_riders ( )

Definition at line 165 of file vehicleriders_shared.gsc.

References get_in(), and spawn().

Referenced by on_ai_spawned(), and on_vehicle_spawned().

◆ unclaim_position()

function unclaim_position	(	vh	,
		str_pos
	)

Definition at line 130 of file vehicleriders_shared.gsc.

References clear().

Referenced by _unclaim_position_on_death(), and get_out().

◆ unload()

function unload	(	str_group	= `"all"`,
		str_mode	,
		remove_rider_before_unloading	,
		remove_riders_wait_time
	)

Description:

"Summary: Unload riders from a vehicle" "Function Name: unload( str_group )" "CallOn: Vehicle"
"Optional Argument(s): [str_group] Unload a specific group instead of all riders (all, driver, passengers, crew, gunners)."
"Example:vh_truck vehicle::unload( "all" );"
"Example:vh_truck vehicle::unload( "gunners" );"

Definition at line 584 of file vehicleriders_shared.gsc.

References ARRAY_ADD, get_out(), remove_riders_after_wait(), and VAL.

Referenced by Epilog(), and unload_node().

Macros

Functions

Macro Definition Documentation

◆ GROUND_HEIGHT

Function Documentation

◆ __init__()

◆ _init_rider()

◆ _unclaim_position_on_death()

◆ can_get_in()

◆ claim_position()

◆ delete_rider_asap()

◆ exit_ground()

◆ exit_high_loop_anim()

◆ exit_low()

◆ exit_variable()

◆ find_next_open_position()

◆ forward_euler_integration()

◆ get_bundle()

◆ get_bundle_for_ai()

◆ get_height()

◆ get_in()

◆ get_out()

◆ get_rider()

◆ get_rider_info()

◆ get_robot_bundle()

◆ handle_falling_death()

◆ handle_rider_death()

◆ is_seat_available()

◆ kill_rider()

◆ on_ai_spawned()

◆ on_vehicle_killed()

◆ on_vehicle_spawned()

◆ ragdoll_dead_exit_rider()

◆ remove_riders_after_wait()

◆ seat_position_to_index()

◆ set_goal()

◆ spawn_riders()

◆ unclaim_position()

◆ unload()

◆ init()