struct.csc File Reference

Go to the source code of this file.

Functions
function	delete ()
function	delete_script_bundle (str_type, str_name)
function	get (kvp_value, kvp_key="targetname")
function	get_array (kvp_value, kvp_key="targetname")
function	get_script_bundle (str_type, str_name)
function	get_script_bundle_instances (str_type, str_name="")
function	get_script_bundle_list (str_type, str_name)
function	get_script_bundles (str_type)
function	get_script_bundles_of_type (str_type)
function	init ()
function	spawn (v_origin=(0, 0, 0), v_angles=(0, 0, 0))

Function Documentation

delete()

function delete

(

)

Definition at line 2 of file struct.csc.

delete_script_bundle()

function delete_script_bundle	(	str_type	,
		str_name
	)

Description:
"Function Name: delete_script_bundle( <str_type>, <str_name> )"
"Summary: Deletes the specified script bundle definition. This is the GDT data for the bundle."
"Mandatory Argument(s): <str_type> : The type of the script bundle"
"Mandatory Argument(s): <str_name> : The name of the script bundle"
"Example:struct::delete_script_bundle( "scene", "my_scene" );"
"Single Player / Multi Player: both"

Definition at line 56 of file struct.csc.

get()

function get	(	kvp_value	,
		kvp_key	= "targetname"
	)

Description:
"Function Name: get( <kvp_value> , [kvp_key] )"
"Summary: Returns a struct with the specified kvp."
"Mandatory Argument(s): <kvp_value> : kvp value"
"Optional Argument(s): [kvp_key] : defaults to targetname"
"Example:struct::get( "some_value", "targetname" );"
"Single Player / Multi Player: both"

Definition at line 13 of file struct.csc.

Referenced by __main__(), cSceneObject::_play_shared_player_anim(), cSceneObject::_play_shared_player_anim_for_player(), cSceneObject::_prepare_player(), cSceneObject::_set_goal(), _turret_new_user_think(), actor_lase_points_behavior(), add_dynamic_wallbuy(), cSecuritySystem::alert_security_system(), blocker_init(), bridge_init(), Callback_HostMigration(), camo_is_inuse(), can_pack_weapon(), can_use_filter(), can_we_spawn_raps(), cannon_effect(), check_for_instakill(), check_for_rare_drop_override(), check_octobomb_on_train(), check_quickrevive_for_hotjoin(), checkForTracking(), CleanupThread(), colorNode_spawn_reinforcement(), combatRobotDamageOverride(), console_blue(), console_green(), console_red(), debris_think(), default_delayed_exit(), default_find_exit_point(), disable_perk_before_power(), disable_quickrevive(), do_player_or_npc_playvox(), doEndGameSequence(), dog_clip_monitor(), dog_round_tracker(), dog_round_wait_func(), door_close_disconnect(), door_open_update(), door_opened(), door_think(), door_update(), end_game_state(), extend_left_arm(), extend_right_arm(), extracam_init_index(), factory_find_exit_point(), find_next_open_position(), cSceneObject::finish(), gadget_armor_off(), gadget_armor_status(), gadget_cacophany_is_inuse(), gadget_cleanse_is_inuse(), gadget_concussive_wave_is_inuse(), gadget_drone_is_inuse(), gadget_es_strike_is_inuse(), gadget_exo_breakdown_is_inuse(), gadget_firefly_swarm_is_inuse(), gadget_flashback_is_inuse(), gadget_forced_malfunction_is_inuse(), gadget_hacker_is_inuse(), gadget_hacker_on(), gadget_iff_override_is_inuse(), gadget_immolation_is_inuse(), gadget_misdirection_is_inuse(), gadget_mrpukey_is_inuse(), gadget_multirocket_fire(), gadget_multirocket_flicker(), gadget_multirocket_is_flickering(), gadget_multirocket_is_inuse(), gadget_overdrive_is_inuse(), gadget_rapid_strike_is_inuse(), gadget_ravage_core_is_inuse(), gadget_resurrect_delay_updateTeamStatus(), gadget_resurrect_is_player_predead(), gadget_resurrect_on_spawned(), gadget_resurrect_secondary_deathcam_time(), gadget_security_breach_is_inuse(), gadget_sensory_overload_is_inuse(), gadget_servo_shortout_is_inuse(), gadget_smokescreen_is_inuse(), gadget_speed_burst_is_inuse(), gadget_surge_is_inuse(), gadget_system_overload_is_inuse(), gadget_turret_deploy_is_inuse(), gadget_turret_deploy_off(), gadget_turret_deploy_on(), gadget_unstoppable_force_is_inuse(), gadget_vision_pulse_is_inuse(), game_module_custom_intermission(), get_current_frozen_moment_params(), get_desired_origin(), get_existing_ent(), get_in(), get_out(), get_vehiclenode_any_dynamic(), getMinimumFlyHeight(), homepad_loop(), increment_take_cover_warnings_on_death(), infrared_is_inuse(), init(), init_node_scan(), init_shared(), init_spawnable_weapon_upgrade(), init_traverse(), initJumpStruct(), is_chest_active(), is_igc_active(), is_node_script_struct(), is_playing(), is_power_on(), is_ready(), is_seat_available(), jump_pad_init(), jump_pad_start(), laser_awareness(), last_stand_best_pistol(), last_stand_compare_pistols(), last_stand_pistol_swap(), cSecurityMover::load_pathstructs(), margwaHeadLeftCallback(), margwaHeadMidCallback(), margwaHeadRightCallback(), MarkerUpdateThread(), mechzNotetrackShootGrenade(), minigun_no_drop(), missileLockWatcher(), monitor_tracker_perk(), cRailTurret::move_along_path(), move_platform(), multi_extracam_init(), nuke_delay_spawning(), on_local_player_spawned(), on_player_spawned(), onFindValidSpawnPoint(), onPlayerConnect_check_for_hotjoin(), overrideSpawn(), packa_door_reminder(), paths(), perk_machine_spawn_init(), perk_power_off(), perk_wire_fx_client(), play_packa_see_vox(), play_tele_help_vox(), player_craft(), player_damage_override(), player_init(), player_last_stand_stats(), player_laststand(), player_out_of_playable_area_monitor(), player_teleporting(), player_too_many_weapons_monitor_takeaway_simultaneous(), playerHealthRegen(), playerHurtcheck(), power_electric_switch(), prepareTopThreePlayers(), QRDrone_watch_distance(), raps_round_tracker(), raps_round_wait_func(), ready_to_spawn_wasp(), reenable_quickrevive(), replenish_after_rounds(), resurrect_watch_for_death(), revive_solo_fx(), robotLightsHandler(), robotMindControlHandler(), round_spawn_failsafe(), round_wait(), SecondaryFacialAnimationThink(), set_goal(), set_goal_volume(), set_igc_active(), setNameAndRank(), setup_elevator_gates(), setup_general_container_bundle(), setup_menu(), cSecurityMover::setup_mover(), setup_wc_extracam_settings(), setup_wc_weapon_model(), shield_is_inuse(), show_hud(), showScoreboard(), showTopThreePlayers(), soundLineThink(), spawn_at_struct(), cRailTurret::spawn_at_struct(), StartDartRemoteControl(), StartSentinelRemoteControl(), target_lase_next(), teleport_core_hint_update(), teleporter_wire_wait(), thrasherHideFromPlayer(), thrasherRestorePustule(), thrasherSporeDamageCallback(), treasure_chest_think(), turn_revive_on(), turret_movement_behavior(), cRailTurret::turret_movement_behavior(), update(), update_based_on_flags(), update_character_animation_and_attachments(), update_client(), update_hint_string(), update_hud(), update_use_frozen_moments(), cDoor::update_use_message(), visionset_update_cb(), wait_and_revive(), wallbuy_callback_idx(), wallbuy_player_connect(), wasp_round_tracker(), wasp_round_wait_func(), watch_for_emp_close(), WatchCombatRobotHelicopterHacked(), WatchCombatRobotLanding(), WatchCombatRobotShutdown(), watchRestartFX(), zombie_can_drop_powerups(), and zone_flag_wait().

get_array()

function get_array	(	kvp_value	,
		kvp_key	= "targetname"
	)

Description:
"Function Name: get_array( <kvp_value> , [kvp_key] )"
"Summary: Returns an array of structs with the specified kvp."
"Mandatory Argument(s): <kvp_value> : kvp value"
"Optional Argument(s): [kvp_key] : defaults to targetname"
"Example:fxemitters = struct::get_array( "streetlights", "targetname" )"
"Single Player / Multi Player: both"

Definition at line 34 of file struct.csc.

Referenced by __init__(), __main__(), autofill_wallbuys_init(), deactivate_initial_barrier_goals(), define_elevator_parts(), delete_in_createfx(), electric_switch(), enable_zone(), fireworks_launch(), generate_zombie_craftable_piece(), get_guide_struct_angles(), get_node_funcs_based_on_target(), get_player_spawns_for_gametype(), get_target_structs(), get_trigger_look_target(), get_valid_spawn_location(), hardpoint(), helicopter_crash_movement(), heliGuardSupport_setAirNodeMesh(), heliGuardSupport_setAirStartNodes(), hostmigration_put_player_in_better_place(), init(), init_blockers(), init_clientfields(), init_node_scan(), init_perk_machines_fx(), init_spawnable_weapon_upgrade(), initJumpStruct(), jump_pad_init(), lock_additional_player_spawner(), move_ring(), onFindValidSpawnPoint(), onStartGameType(), pa_init(), pa_single_init(), patrol_next_node(), perk_machine_spawn_init(), play(), player_init(), player_intermission(), reinit_zone_spawners(), set_intermission_point(), setup_all_traps(), cSecuritySystem::setup_in_array(), skip_scene(), sndPASetup(), spawn_recharge_tanks(), cSecuritySystem::spawn_turrets(), start_carpenter(), start_carpenter_new(), start_lights(), startLineEmitters(), startRattles(), startSoundLoops(), startSoundRandoms(), stop(), teleport_pad_init(), trap_activate_electric(), trap_activate_fire(), trap_fx_monitor(), trap_init(), trigger_issues_orders(), unlock(), unlock_all(), update_target_array(), VehicleMainThread(), and zone_init().

get_script_bundle()

function get_script_bundle	(	str_type	,
		str_name
	)

Description:
"Function Name: get_script_bundle( <str_type>, <str_name> )"
"Summary: Returns a struct with the specified script bundle definition. This is the GDT data for the bundle."
"Mandatory Argument(s): <str_type> : The type of the script bundle"
"Mandatory Argument(s): <str_name> : The name of the script bundle"
"Example:struct::get_script_bundle( "scene", "my_scene" );"
"Single Player / Multi Player: both"

Definition at line 45 of file struct.csc.

Referenced by __init__(), __main__(), _load_female_scene(), _setup_(), addEpicSceneFunc(), ai_tank_killstreak_start(), ambient_anim_toggle(), amws_initialize(), control_lights_groups(), counteruav_initialize(), do_side_death_fx(), dragon_initialize(), field_death_spawn_dynents(), field_do_empdeathfx(), field_gib_spawn_dynents(), field_toggle_lensflare(), field_update_alert_level(), field_update_damage_state(), get_bot_default_settings(), get_bot_settings(), get_bundle(), get_commander_dialog_alias(), get_player_dialog_alias(), get_random_key(), get_random_pilot_index(), get_robot_bundle(), get_scenedef(), glaive_initialize(), glaiveBloodFxHandler(), hunter_initialize(), init(), InitSentinel(), lights_group_toggle(), main(), marker_state_changed(), mechtank_initialize(), monitor_drop_landing(), mpdialog_value(), parasite_initialize(), parasiteSecondaryDeathFxHandler(), parasiteTellFxHandler(), play_next_killstreak_dialog(), play_vehicle_anim(), playDupRenderBundle(), playEpicTauntScene(), playPostfxBundle(), quadtank_initialize(), raps_initialize(), register_killstreak_bundle(), sarah_minigun_spin(), scout_drone_initialize(), sentinel_drone_deathfx(), sentinel_drone_initialize(), set_trophy_state(), set_vehicleriders_bundle(), setAITankhrustersState(), setDiffStructArrays(), setSupplydropThrustersState(), setup_container_scriptbundle(), should_update_damage_fx_level(), siegebot_initialize(), spider_initialize(), stopEpicTauntScene(), toggle_fx_bundle(), turret_initialze(), UpdateMarkerThread(), wait_for_bullet_impact(), and wasp_initialize().

get_script_bundle_instances()

function get_script_bundle_instances	(	str_type	,
		str_name	= ""
	)

Description:
"Function Name: get_script_bundle_instances( <str_type>, [str_name] )"
"Summary: Returns an array of all the script bundle instances with the specified script bundle definition and name."
"Mandatory Argument(s): <str_type> : The type of the script bundle"
"Mandatory Argument(s): [str_name] : The name of the script bundle"
"Example:struct::get_script_bundle_instances( "scene", "my_scene" );"
"Single Player / Multi Player: both"

Definition at line 99 of file struct.csc.

Referenced by run_instances().

get_script_bundle_list()

function get_script_bundle_list	(	str_type	,
		str_name
	)

Description:
"Function Name: get_script_bundle_list( <str_type>, <str_name> )"
"Summary: Returns a string array with the items specified by the script bundle list."
"Mandatory Argument(s): <str_type> : The type of the script bundle in the list"
"Mandatory Argument(s): <str_name> : The name of the script bundle list"
"Example:struct::get_script_bundle_list( "collectible", "completecollectibleslist" );"
"Single Player / Multi Player: both"

Definition at line 88 of file struct.csc.

get_script_bundles()

function get_script_bundles

(

str_type

)

Description:
"Function Name: get_script_bundles( <str_type> )"
"Summary: Returns all of the script bundle definition structs for the specified type."
"Mandatory Argument(s): <str_type> : The type of the script bundle"
"Example:struct::get_script_bundles( "scene" );"
"Single Player / Multi Player: both"

Definition at line 77 of file struct.csc.

Referenced by __init__(), get_scenedefs(), and register_dialog().

get_script_bundles_of_type()

function get_script_bundles_of_type

(

str_type

)

Description:
"Function Name: get_script_bundle( <str_type>, <str_name> )"
"Summary: Returns a struct with the specified script bundle definition. This is the GDT data for the bundle."
"Mandatory Argument(s): <str_type> : The type of the script bundle"
"Mandatory Argument(s): <str_name> : The name of the script bundle"
"Example:struct::get_script_bundle( "scene", "my_scene" );"
"Single Player / Multi Player: both"

Definition at line 67 of file struct.csc.

init()

function init

(

)

Definition at line 1 of file struct.csc.

Referenced by __init__(), __main__(), _init_turret(), add_adjacent_zone(), aigroup_init(), bridge_init(), Callback_VehicleSpawned(), CodeCallback_ServerSceneInit(), console_blue(), console_green(), console_red(), cSecuritySystem::constructor(), constructor(), crawl_target_and_init_flags(), create_flags_and_return_tokens(), croc_movementupdate(), debris_init(), deploy_turret(), door_init(), enable_quick_revive_perk_for_level(), ent_flag_init_ai_standards(), escort_drone_movementupdate(), flag_blocker(), flag_clear_trigger(), flag_set_touching(), flag_set_trigger(), gadget_drone_spawn(), init_blockers(), jump_pad_think(), main(), missileLockWatcher(), patrol(), playerHealthRegen(), process_deathflags(), quadrotor_movementupdate(), script_flag_set_touching(), sentinel_is_drone_initialized(), set_dr_flag(), set_dr_flag_not_array(), setup(), cSecurityDoor::setup(), spawn_at_struct(), cRailTurret::spawn_at_struct(), spawn_init(), template_test_zone_init(), treasure_chest_init(), trigger_look(), and zone_flag_wait().

spawn()

function spawn	(	v_origin	= (0, 0, 0),
		v_angles	= (0, 0, 0)
	)

Description:
"Function Name: spawn( [v_origin], [v_angles] )"
"Summary: Returns a new struct."
"Optional Argument(s): [v_origin] : optional origin"
"Optional Argument(s): [v_angles] : optional angles"
"Example:s = struct::spawn( self GetTagOrigin( "tag_origin" ) );"

Definition at line 23 of file struct.csc.

Referenced by _CloneOrbFx(), _CreateGuardMarker(), _CreatePhalanxTier(), _fire(), _network_safe_spawn(), _spawn_husk(), ActivateSatellite(), ActivateUAV(), AllowMainTurretLockon(), armblade_sound_thread(), attachReconModel(), bombPlanted(), bombs(), Callback_HostMigration(), camo_bread_crumb(), check_point_in_enabled_zone(), check_point_in_playable_area(), cDoor::close_internal(), colorNode_spawn_reinforcement(), crateSpawn(), create_flare_ent(), create_killcam_entity(), create_locker_trigger(), createCarryQRDrone(), createFlag(), createFlagHint(), createKillcamEnt(), createQRDrone(), CreateRapsHelicopterInfluencer(), CreateRemoteWeaponTrigger(), croc_movementupdate(), damageEffectArea(), damageInPoisonArea(), damagePlayerInRadius(), default_onSpawnIntermission(), default_onSpawnSpectator(), destructible_cover_think(), detonation_monitor(), do_resurrect_hint_fx(), do_zombie_fall(), do_zombie_rise(), doBombRun(), door_wait_until_clear(), drone_rotate_angle(), drone_up_down_transition(), EnterHelicopter(), fireFlares(), fireworks_launch(), flashbackTrailFx(), floor_collapse_init(), gadget_drone_spawn(), gadget_multirocket_target_acquire(), gadget_turret_deploy_on(), gadget_vision_pulse_start(), game_module_custom_intermission(), get_heli_sound_ent(), get_zone_from_position(), give_ai_key_internal(), hackerInit(), heat_wave_burn_sound(), heat_wave_fx(), heli_think(), HelicopterGunnerDamageOverride(), heliDeliverCrate(), heliGuardSupport_watchSAMProximity(), hostMigrationTimerThink_Internal(), hunter_scanner_init(), init(), init_spawns(), cDoor::init_trigger(), InitHelicopterSeat(), InitRotatingRig(), jump_pad_move(), last_stand_monitor(), leave_dart(), lightninggun_arc_fx(), lockPlayerForQRDroneLaunch(), loop_fx_sound(), machine_sounds(), machine_think(), magicbox_glow_callback(), MarkerUpdateThread(), missile_sound_play(), MissileTarget_DeployFlares(), monitor_dog_special_grenades(), move_zombie_spawn_location(), on_player_connect(), onBeginUseUTS(), onSpawn(), onSpawnHatchetTrigger(), onSpawnIntermission(), onSpawnPlayer(), onSpawnRetrievableWeaponObject(), onSpawnRetrieveTrigger(), onSpawnSpecialCrossbowTrigger(), onStartGameType(), cDoor::open_internal(), overrideSpawn(), perk_wire_fx_client(), place_navcard(), play_afterburner_fx(), play_concussion_sound(), play_lockon_sounds(), play_loop_on_machine(), play_perk_fx_on_client(), play_remote_fx(), play_tesla_sound(), playConcussionSound(), player_throw_cymbal_monkey(), player_throw_piece(), playFlashSound(), PlayLockOnSoundsThread(), playNotifyLoop(), playSmokeSound(), playTabunSound(), powerup_zombie_grab(), projectile_cam(), projectile_spawn(), projectile_spawn_utility(), proximity_detonate(), proximityGrenadeChain(), proximityWeaponObject_CreateDamageArea(), QRDrone_dmg_snd(), QRDrone_watch_distance(), raps_spawn_fx(), really_play_2D_sound(), register_dyn_unitrigger(), register_static_unitrigger(), remote_mortar_spawn(), revive_trigger_spawn(), setup(), cTeamGather::setup_gameobject(), setup_general_container_bundle(), setup_heli_sounds(), setup_terrain_brass_sounds(), setup_terrain_sounds(), SetupCombatRobotHintTrigger(), setupKillCamEnt(), singleLocation(), sndAnnouncerPlayVox(), sndChyronLoop(), sndCountdown(), sndFireDamage(), sndFiresaleMusic_Start(), sndMusicSystem_CreateState(), sndPASetup(), soundplayuidecodeloop(), spawn_at_struct(), cRailTurret::spawn_at_struct(), spawn_buildkit_weapon_model(), spawn_dog_tag(), spawn_firefly_mover(), spawn_helicopter(), spawn_joker_weapon_model(), spawn_kill_brush(), spawn_life_brush(), spawn_player_arms(), spawn_player_clone(), spawn_riders(), spawn_weapon_model(), spawn_zombie(), spawnAllLocs(), spawned(), spawnKillTrigger(), spawnMineMover(), SpawnMoveTrigger(), SpawnPlaceable(), spawnPlayer(), spawnRiotshieldCover(), spawnSmokeGrenadeTrigger(), spawnTacticalInsertion(), spawnThiefBeamEffect(), spawnUseEnt(), special_powerup_drop(), start_bonfire_sale(), start_carpenter(), start_carpenter_new(), start_timed_vortex(), start_vortex_fx(), StartMicrowave(), StartMicrowaveFx(), swarm_killstreak_fx(), swarm_sound(), tank_low_health_fx(), tear(), tesla_play_arc_fx(), tesla_sound_thread(), time_remaining_on_point_doubler_powerup(), timeLimitClock(), timeLimitClock_Intermission(), trap_audio(), trigger_spawner_spawn(), useKillstreakStrafeRun(), VehicleSpawnThread(), vending_weapon_upgrade(), watch_explosive_crate(), watchForExplode(), watchForHeroKill(), weaponObjectDetectionTrigger(), weaponStun(), zmbMusLooper(), zmbVox(), and zombie_spawn_failed().