Inheritance diagram for _File:

Public Types
enum	ModeFlags { READ =1, WRITE =2, READ_WRITE =3, WRITE_READ =7 }

Public Types inherited from Object
enum	ConnectFlags { CONNECT_DEFERRED =1, CONNECT_PERSIST =2, CONNECT_ONESHOT =4 }

enum	{ NOTIFICATION_POSTINITIALIZE =0, NOTIFICATION_PREDELETE =1 }

Public Member Functions
Error	open_encrypted (const String &p_path, int p_mode_flags, const Vector< uint8_t > &p_key)

Error	open_encrypted_pass (const String &p_path, int p_mode_flags, const String &p_pass)

Error	open (const String &p_path, int p_mode_flags)
	open a file

void	close ()
	close a file

bool	is_open () const
	true when file is open

void	seek (int64_t p_position)
	seek to a given position

void	seek_end (int64_t p_position=0)
	seek from the end of file

int64_t	get_pos () const
	get position in the file

int64_t	get_len () const
	get size of the file

bool	eof_reached () const
	reading passed EOF

uint8_t	get_8 () const
	get a byte

uint16_t	get_16 () const
	get 16 bits uint

uint32_t	get_32 () const
	get 32 bits uint

uint64_t	get_64 () const
	get 64 bits uint

float	get_float () const

double	get_double () const

real_t	get_real () const

Variant	get_var () const

DVector< uint8_t >	get_buffer (int p_length) const
	get an array of bytes

String	get_line () const

String	get_as_text () const

void	set_endian_swap (bool p_swap)

bool	get_endian_swap ()

Error	get_error () const
	get last error

void	store_8 (uint8_t p_dest)
	store a byte

void	store_16 (uint16_t p_dest)
	store 16 bits uint

void	store_32 (uint32_t p_dest)
	store 32 bits uint

void	store_64 (uint64_t p_dest)
	store 64 bits uint

void	store_float (float p_dest)

void	store_double (double p_dest)

void	store_real (real_t p_real)

void	store_string (const String &p_string)

void	store_line (const String &p_string)

virtual void	store_pascal_string (const String &p_string)

virtual String	get_pascal_string ()

Vector< String >	get_csv_line (String delim=",") const

void	store_buffer (const DVector< uint8_t > &p_buffer)
	store an array of bytes

void	store_var (const Variant &p_var)

bool	file_exists (const String &p_name) const
	return true if a file exists

Public Member Functions inherited from Reference
_FORCE_INLINE_ bool	is_referenced () const

bool	init_ref ()

void	reference ()

bool	unreference ()

int	reference_get_count () const

Public Member Functions inherited from Object
_FORCE_INLINE_ void	_change_notify (const char *p_what="")

bool	_is_gpl_reversed () const

_FORCE_INLINE_ ObjectID	get_instance_ID () const

void	add_change_receptor (Object *p_receptor)

void	remove_change_receptor (Object *p_receptor)

template<class T >
T *	cast_to ()

template<class T >
const T *	cast_to () const

virtual String	get_type () const

virtual String	get_save_type () const

virtual bool	is_type (const String &p_type) const

virtual bool	is_type_ptr (void *p_ptr) const

_FORCE_INLINE_ const StringName &	get_type_name () const

void	set (const StringName &p_name, const Variant &p_value, bool *r_valid=NULL)

Variant	get (const StringName &p_name, bool *r_valid=NULL) const

void	get_property_list (List< PropertyInfo > *p_list, bool p_reversed=false) const

bool	has_method (const StringName &p_method) const

void	get_method_list (List< MethodInfo > *p_list) const

Variant	callv (const StringName &p_method, const Array &p_args)

virtual Variant	call (const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error)

virtual void	call_multilevel (const StringName &p_method, const Variant **p_args, int p_argcount)

virtual void	call_multilevel_reversed (const StringName &p_method, const Variant **p_args, int p_argcount)

Variant	call (const StringName &p_name, VARIANT_ARG_LIST)

void	call_multilevel (const StringName &p_name, VARIANT_ARG_LIST)

void	notification (int p_notification, bool p_reversed=false)

virtual Variant	getvar (const Variant &p_key, bool *r_valid=NULL) const

virtual void	setvar (const Variant &p_key, const Variant &p_value, bool *r_valid=NULL)

void	set_script (const RefPtr &p_script)

RefPtr	get_script () const

bool	has_meta (const String &p_name) const

void	set_meta (const String &p_name, const Variant &p_value)

Variant	get_meta (const String &p_name) const

void	get_meta_list (List< String > *p_list) const

void	set_script_instance (ScriptInstance *p_instance)

_FORCE_INLINE_ ScriptInstance *	get_script_instance () const

void	add_user_signal (const MethodInfo &p_signal)

void	emit_signal (const StringName &p_name, VARIANT_ARG_LIST)

void	emit_signal (const StringName &p_name, const Variant **p_args, int p_argcount)

void	get_signal_list (List< MethodInfo > *p_signals) const

void	get_signal_connection_list (const StringName &p_signal, List< Connection > *p_connections) const

void	get_all_signal_connections (List< Connection > *p_connections) const

Error	connect (const StringName &p_signal, Object *p_to_object, const StringName &p_to_method, const Vector< Variant > &p_binds=Vector< Variant >(), uint32_t p_flags=0)

void	disconnect (const StringName &p_signal, Object *p_to_object, const StringName &p_to_method)

bool	is_connected (const StringName &p_signal, Object *p_to_object, const StringName &p_to_method) const

void	call_deferred (const StringName &p_method, VARIANT_ARG_LIST)

void	set_block_signals (bool p_block)

bool	is_blocking_signals () const

Variant::Type	get_static_property_type (const StringName &p_property, bool *r_valid=NULL) const

virtual void	get_translatable_strings (List< String > *p_strings) const

virtual void	get_argument_options (const StringName &p_function, int p_idx, List< String > *r_options) const

StringName	XL_MESSAGE (const StringName &p_message) const

StringName	tr (const StringName &p_message) const

bool	is_queued_for_deletion () const

_FORCE_INLINE_ void	set_message_translation (bool p_enable)

_FORCE_INLINE_ bool	can_translate_messages () const

void	clear_internal_resource_paths ()

Static Protected Member Functions
static void	_bind_methods ()

Static Protected Member Functions inherited from Reference
static void	_bind_methods ()

Static Protected Member Functions inherited from Object
static String	_get_category ()

static void	_bind_methods ()

static void	get_valid_parents_static (List< String > *p_parents)

static void	_get_valid_parents_static (List< String > *p_parents)

Additional Inherited Members
Static Public Member Functions inherited from Object
static void	initialize_type ()

static _FORCE_INLINE_ void	register_custom_data_to_otdb ()

static void *	get_type_ptr_static ()

static void	get_inheritance_list_static (List< String > *p_inheritance_list)

static String	get_type_static ()

static String	get_parent_type_static ()

static String	get_category_static ()

Public Attributes inherited from Object
bool	_is_queued_for_deletion

Protected Member Functions inherited from Object
virtual bool	_use_builtin_script () const

virtual void	_initialize_typev ()

virtual bool	_setv (const StringName &p_name, const Variant &p_property)

virtual bool	_getv (const StringName &p_name, Variant &r_property) const

virtual void	_get_property_listv (List< PropertyInfo > *p_list, bool p_reversed) const

virtual void	_notificationv (int p_notification, bool p_reversed)

bool	_set (const StringName &p_name, const Variant &p_property)

bool	_get (const StringName &p_name, Variant &r_property) const

void	_get_property_list (List< PropertyInfo > *p_list) const

void	_notification (int p_notification)

void	cancel_delete ()

virtual void	_changed_callback (Object p_changed, const char p_prop)

Variant	_call_bind (const Variant **p_args, int p_argcount, Variant::CallError &r_error)

Variant	_call_deferred_bind (const Variant **p_args, int p_argcount, Variant::CallError &r_error)

virtual const StringName *	_get_type_namev () const

DVector< String >	_get_meta_list_bind () const

Array	_get_property_list_bind () const

Array	_get_method_list_bind () const

void	_clear_internal_resource_paths (const Variant &p_var)

Protected Attributes inherited from Object
_FORCE_INLINE_ bool(Object::*)(const StringName &p_name, Variant &r_ret)	_get_get () const)

_FORCE_INLINE_ bool(Object::*)(const StringName &p_name, const Variant &p_property)	_get_set () const)

_FORCE_INLINE_ void(Object::)(List< PropertyInfo > p_list)	_get_get_property_list () const)

_FORCE_INLINE_ void(Object::*)(int)	_get_notification () const)

Static Protected Attributes inherited from Object
static _FORCE_INLINE_ void(*)()	_get_bind_methods ()

Member Function Documentation

String _File::get_as_text ( ) const

use this for files WRITTEN in big endian machines (ie, amiga/mac) It's not about the current CPU type but file formats. this flags get reset to false (little endian) on each open

Vector< String > _File::get_csv_line ( String delim = "," ) const

use this for files WRITTEN in big endian machines (ie, amiga/mac) It's not about the current CPU type but file formats. this flags get reset to false (little endian) on each open

The documentation for this class was generated from the following files:

/Users/huihoo/Downloads/godot-2.0.4-stable/core/bind/core_bind.h
/Users/huihoo/Downloads/godot-2.0.4-stable/core/bind/core_bind.cpp

Public Types

Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Function Documentation