source: GTP/trunk/App/Demos/Illum/Shark3D/version164x12u/IllumDemo/src/res/client/actor/client.s3d_actor @ 2196

///////////////////////////////////////////////////////////////////////////////
//
//      ##  ######
//       ######  ###
//  ## ###############        Shark 3D Engine (www.shark3d.com)
//   ########## # # #
//    ########                Copyright (c) 1996-2006 Spinor GmbH.
//   ######### # # #          All rights reserved.
//  ##   ##########
//      ##
//
///////////////////////////////////////////////////////////////////////////////

// Definition of the game client.
// This file defines all actors used on client side.
// It includes the graphic output definitions "client/actor/gfx.s3d_actor_run"
// and the display defintion "client/actor/display.s3d_actor_run".

// The client root actor is a capsule, defining an own local namespace.
actor_ident "kit_base.capsule"
actor_param
{
    // Delegate the action calls to all children:
    active 1
    // Scope name. Used in error messages.
    scope "client"
    // Name of the capsule actor within its own namespace.
    // Actors within the capsule can access the capsule
    // actor itself by this name.
    local_name "capsule"
    // Delegate commands from outside to the correct dispatcher.
    deleg_target "dispatch_export"
    // The capsule actor contains a group of actors:
    child_ident "kit_base.group"
    child_param
    {
        // Delegate action calls to the children.
        active 1
        child_array
        {
            // Dispatcher for commands from outside the client capsule.
            ident "kit_base.dispatch"
            param
            {
                name "dispatch_export"
                entry_array
            }
        }
        {
            // Central command dispatch actor.
            // This dispatcher is used internally within the client.
            ident "kit_base.dispatch"
            param
            {
                name "dispatch"
                entry_array
                {
                    cmds "set_camera_transf"
                    targets "io"
                }
                {
                    cmds "io_reloaded"
                    targets "universeplayer_refresh_charge"
                    newcmd "perform"
                }
            }
        }
        {
            // This dispatcher is used to filter input commands.
            ident "kit_base.dispatch"
            param
            {
                name "dispatch_input"
                entry_array
                {
                    cmds "quit" "res_refresh_all"
                    targets "^root"
                }
                {
                    cmds "store_file_default"
                    targets "store_file_default"
                    newcmd "perform"
                }
                {
                    cmds "load_file_default"
                    targets "load_file_default"
                    newcmd "perform"
                }
                {
                    // Send these commands to server:
                    cmds
                        "fire" "directfire" "god" "special"
                        "goto_level0" "goto_level1" 
                        "goto_level2" "goto_level3"
                        "goto_level4" "goto_level5"
                        "goto_level6" "goto_level7" 
                        "goto_level8" "goto_level9"
                        "goto_level10" "goto_level11" 
                        "goto_level12" "goto_level13"
                        "goto_level14" "goto_level15"
                        "goto_level16" "goto_level17" 
                        "goto_level18" "goto_level19"
                        "goto_level20" "goto_level21"
                        "goto_level_next" "goto_level_prev"
                    // Delegate to the universe-player:
                    targets "universeplayer"
                }
                {
                    // Send movement commands to the movement control actor:
                    cmds
                        "apply_move_pos_x" "apply_move_neg_x" 
                        "apply_move_pos_y" "apply_move_neg_y" 
                        "apply_move_pos_z" "apply_move_neg_z"
                        "assign_vel_pos_x" "assign_vel_neg_x" 
                        "assign_vel_pos_y" "assign_vel_neg_y" 
                        "assign_vel_pos_z" "assign_vel_neg_z"
                        "switch_vel_pos_x" "switch_vel_neg_x" 
                        "switch_vel_pos_y" "switch_vel_neg_y" 
                        "switch_vel_pos_z" "switch_vel_neg_z"
                        "apply_rot_pos_x" "apply_rot_neg_x" 
                        "apply_rot_pos_y" "apply_rot_neg_y" 
                        "apply_rot_pos_z" "apply_rot_neg_z"
                        "assign_spin_pos_x" "assign_spin_neg_x" 
                        "assign_spin_pos_y" "assign_spin_neg_y" 
                        "assign_spin_pos_z" "assign_spin_neg_z"
                        "switch_spin_pos_x" "switch_spin_neg_x" 
                        "switch_spin_pos_y" "switch_spin_neg_y" 
                        "switch_spin_pos_z" "switch_spin_neg_z"
                        "jump"
                    targets "motion"
                }
                {
                    // Commands for gfx:
                    cmds "set_cursor_x" "set_cursor_y"
                        "move_cursor_x" "move_cursor_y"
                        "toggle_gfxmeshwire" "toggle_gfxboundwire"
                        "toggle_gfxshvolwire"
                        "toggle_physmeshwire" "toggle_physboundwire"
                        "toggle_physcontactwire"
                        "toggle_noisewire"
                        "toggle_sensormeshwire" "toggle_sensorboundwire"
                        "reset_msg"
                        "toggle_frmtime" "toggle_stat" "reset_stat"
                        "toggle_fullscreen"
                        "toggle_catch_mouse"
                    targets "io"
                }
                {
                    cmds "reload_io"
                    targets "io_extern"
                    newcmd "load_current"
                }
                {
                    // Character input
                    cmds "handle_char"
                    targets
                }
            }
        }
        {
            // Dispatcher of commands coming from the server.
            ident "kit_base.dispatch"
            param
            {
                name "dispatch_universe"
                entry_array
                {
                    cmds "get_basesuppl"
                    targets "sersuppl"
                    newcmd "get_obj"
                }
                {
                    cmds "ignore_frmtime"
                    targets "^root"
                }
                {
                    cmds "cfg_access_int_info"
                    targets "^cfg"
                    newcmd "access_int_info"
                }
                {
                    cmds "cfg_access_float_info"
                    targets "^cfg"
                    newcmd "access_float_info"
                }
                {
                    cmds "cfg_access_str_info"
                    targets "^cfg"
                    newcmd "access_str_info"
                }
                {
                    cmds "cfg_access_chunk_info"
                    targets "^cfg"
                    newcmd "access_chunk_info"
                }
                {
                    cmds "universe_cfg_access_int_info"
                    targets "universe_cfg"
                    newcmd "access_int_info"
                }
                {
                    cmds "universe_cfg_access_float_info"
                    targets "universe_cfg"
                    newcmd "access_float_info"
                }
                {
                    cmds "universe_cfg_access_str_info"
                    targets "universe_cfg"
                    newcmd "access_str_info"
                }
                {
                    cmds "universe_cfg_access_chunk_info"
                    targets "universe_cfg"
                    newcmd "access_chunk_info"
                }
                {
                    cmds "enable_notice_destroying" "disable_notice_destroying"
                        "enable_notice_loading" "disable_notice_loading"
                        "enable_notice_saving" "disable_notice_saving"
                    targets
                }
            }
        }
        {
            ident "kit_perch.mgr"
            param
            {
                name "perchmgr"
            }
        }
        {
            ident "kit_snk.data"
            param
            {
                name "universe_cfg"
                val
                {
                    server 0
                }
            }
        }
        {
            ident "kit_base.sersuppl"
            param
            {
                name "sersuppl"
                child "^basesuppl"
            }
        }
        {
            // Dispatcher of commands coming from the server.
            ident "kit_base.dispatch"
            param
            {
                name "dispatch_inform"
                entry_array
                {
                    cmds "set_state_world"
                    targets "state_world"
                    newcmd "set_obj"
                }
                {
                    cmds "set_state_sky"
                    targets "state_sky"
                    newcmd "set_obj"
                }
                {
                    cmds
                        "set_gfxmgr_level"
                        "set_sndmgr_level"
                        "set_state_world"
                        "set_state_sky"
                        "set_sim_world"
                        "set_noise_world"
                        "set_sensorstate_world"
                    targets "io"
                }
                {
                    cmds "set_sim_world"
                    targets "sim_world"
                    newcmd "set_obj"
                }
                {
                    cmds "set_noise_world"
                    targets "noise_world"
                    newcmd "set_obj"
                }
                {
                    cmds "set_sensorstate_world"
                    targets "sensorstate_world"
                    newcmd "set_obj"
                }
                {
                    cmds "set_camera"
                    targets "elem_camera"
                    newcmd "set_obj"
                }
                {
                    cmds "notice_level_load_pre"
                    targets "display"
                    newcmd "enable_notice_loading"
                }
                {
                    cmds "notice_level_load_post"
                    targets "display"
                    newcmd "disable_notice_loading"
                }
                {
                    cmds
                        "notice_level_load_pre"
                        "notice_level_load_post"
                    targets "io"
                    newcmd "suspend_output"
                }
                {
                    cmds
                        "notice_level_load_pre"
                        "notice_level_load_post"
                    targets "io"
                    newcmd "perform_output"
                }
            }
        }
        {
            // Event queue.
            ident "kit_base.evtmgr"
            param
            {
                name "evtmgr"
                active 1
                extcfg_actor "^cfg"
                extcfg_entry_log "log.evtmgr"
            }
        }
        {
            // Information line collection actor.
            // This actor collects per-frame information lines
            // like the frmtime.
            // This actor does not generate the information,
            // but only is responsible for collecting the lines.
            ident "kit_base.inspcollect"
            param
            {
                name "inspcollect"
            }
        }
        {
            ident "kit_engbase.extern"
            param
            {
                name "universe_extern"
                deleg_name "universe"
                allow_no_target 1
                res ""
                active 1
            }
        }
        {
            ident "kit_engbase.plug"
            param
            {
                name "plug"
                deleg_name "plug_root"
                netlink_suppl "^envcompsuppl"
                netlink_ident "eng_base.netlink"
                netlink_param
                {
                    env "^env"
                }
                netroot_target "universe"
                lost_target ""
                lost_cmd ""
                nettraverse_target "universe_extern"
                nettraverse_cmd "traverse"
            }
        }
        {
            // Create a network engine.
            ident "kit_io.neteng"
            param
            {
                name "neteng"
                active 1
                // Get parameters from the actor "cfg", 
                // which is defined above.
                extcfg_actor "^cfg"
                // Get the parameters from the "network" entry.
                extcfg_entry_param "network"
                given_array
                {
                    item "^env"
                    given_ident "env"
                }                
            }
        }
        {
            ident "kit_engbase.plugconnect"
            param
            {
                name "plugconnect"
                plug "plug"
                neteng "neteng"
                localroot "^server"
                extcfg_actor "^cfg"
                extcfg_entry_addr "client.addr"
            }
        }
        {
            ident "kit_engobj.informmgr"
            param
            {
                name "universeplayer_informmgr"
                deleg_name "universeplayer"
                inform "dispatch_inform"
                ignore_no_charge 1
                notify_target ""
                notify_pre_cmd ""
                notify_post_cmd ""
                produce_target "plug_root"
                produce_cmd "produce_player"
            }
        }
        {
            ident "kit_base.paramvoid"
            param
            {
                name "universeplayer_refresh_charge"
                target "universeplayer_informmgr"
                cmd "refresh_charge"
            }
        }
        {
            ident "kit_engobj.fetch"
            param
            {
                name "universeplayer_fetch"
                query_target "universeplayer_informmgr"
                query_cmd "get_charge"
                produce_target "universeplayer_informmgr"
                produce_cmd "produce_charge"
                produce_report_target ""
                produce_report_cmd ""
                enum_target ""
                enum_cmd ""
                enum_report_target ""
                enum_report_cmd ""
            }
        }

        {
            ident "kit_engobj.itemeye"
            param
            {
                name "sim_world"
            }
        }
        {
            ident "kit_engobj.itemeye"
            param
            {
                name "noise_world"
            }
        }
        {
            ident "kit_engobj.itemeye"
            param
            {
                name "sensorstate_world"
            }
        }
        {
            ident "kit_engobj.itemeye"
            param
            {
                name "elem_camera"
            }
        }
        {
            // Define the camera:
            ident "kit_engobj.cameractrl"
            param
            {
                name "cameractrl"
                active 1
                rawtransf_src "elem_camera"
                transf_target "dispatch"
                transf_cmd "set_camera_transf"
            }
        }
        {
            // Include the definition of the display.
            ident "kit_base.extern"
            param
            {
                // Delegate action calls to the child:
                name "display_extern"
                deleg_name "display"
                res "client/actor/display.s3d_actor_run"
                // No watch because display needs "set_clientimageobj_xxx"
                active 1
            }
        }
        {
            // Include actors for movement control:
            ident "kit_base.extern"
            param
            {
                // Delegate action calls to the child:
                deleg_name "motion"
                res "client/actor/motion.s3d_actor_run"
                active 1
            }
        }
        {
            ident "kit_engobj.itemeye"
            param
            {
                name "state_world"
            }
        }
        {
            ident "kit_engobj.itemeye"
            param
            {
                name "state_sky"
            }
        }
        {
            ident "kit_engobj.itemeye"
            param
            {
                name "state_display"
            }
        }
        {
            // Include the definition of the display.
            ident "kit_base.extern"
            param
            {
                // Delegate action calls to the child:
                name "io_extern"
                deleg_name "io"
                res "client/actor/io.s3d_actor_run"
                notify_target "dispatch"
                notify_post_cmd "io_reloaded"
                watch_target "io_extern"
                watch_cmd "load_current"
                active 1
            }
        }

        // The following entry_array define the order of actions
        // performed each frame in the client.
        // General order:
        //   1. Receive data from server.
        //   2. Update output (especially timeconsuming 3D output).
        //   3. Evaluate input.
        //   4. Send data to server.
        // Note that performing input before output would be the wrong order,
        // since the input would not have been evaluated by the server yet-
        // The above order archives that the display reflects the input
        // as soon as possible.
        {
            ident "kit_base.onaction"
            param
            {
                active 1
                target "universeplayer_fetch"
                cmd "check_produce_charge"
            }
        }
        {
            // First, evaluate data received from server:
            ident "kit_base.onaction"
            param
            {
                active 1
                target "plug"
                cmd "poll_recv"
            }
        }
        {
            // Update camera transformation to views and snd.
            ident "kit_base.onaction"
            param
            {
                active 1
                target "cameractrl"
                cmd "update"
            }
        }
        {
            // Render the gfxports and update the sndports:
            ident "kit_base.onaction"
            param
            {
                active 1
                target "io"
                cmd "perform_output"
            }
        }
        {
            // Evaluate input data:
            ident "kit_base.onaction"
            param
            {
                active 1
                target "io"
                cmd "perform_input"
            }
        }
        {
            // Evaluate motin input control:
            ident "kit_base.onaction"
            param
            {
                active 1
                target "motion"
                cmd "update_motion"
            }
        }
        {
            // Send data to server:
            ident "kit_base.onaction"
            param
            {
                active 1
                target "plug"
                cmd "poll_send"
            }
        }
        {
            ident "kit_base.paramstr"
            param
            {
                name "store_file_default"
                target "universeplayer"
                cmd "store_file"
                param "save.sav"
            }
        }
        {
            ident "kit_base.paramstr"
            param
            {
                name "load_file_default"
                target "universeplayer"
                cmd "load_file"
                param "save.sav"
            }
        }
    }
}