libsswf: sswf::ActionPushData Class Reference

Enumerator:

ACTION_IMMEDIATE_TYPE_UNKNOWN
ACTION_IMMEDIATE_TYPE_STRING
ACTION_IMMEDIATE_TYPE_FLOAT
ACTION_IMMEDIATE_TYPE_NULL
ACTION_IMMEDIATE_TYPE_UNDEFINED
ACTION_IMMEDIATE_TYPE_REGISTER
ACTION_IMMEDIATE_TYPE_BOOLEAN
ACTION_IMMEDIATE_TYPE_DOUBLE
ACTION_IMMEDIATE_TYPE_INTEGER
ACTION_IMMEDIATE_TYPE_LOOKUP
ACTION_IMMEDIATE_TYPE_LOOKUP_LARGE

The ActionPushData constructor expects a valid parent tag (a TagHeader or a TagSprite.) Call the Add functions to add the different values necessary on the stack.

Parameters:

[in]

tag

The tag in which this action is inserted

Referenced by Duplicate().

This function adds a boolean value (true or false) to the ActionPushData. Note that it is a good idea to use a boolean value for an ACTION_BRANCH_IF_TRUE byte code. However, this is very similar to an integer or even a float.

Parameters:

[in]

value

The boolean value (true or false)

References ACTION_IMMEDIATE_TYPE_BOOLEAN, sswf::ActionPushData::action_immediate_t::f_boolean, f_data, sswf::ActionPushData::action_immediate_t::f_data, sswf::MemoryManager::MemAttach(), and sswf::Vectors::Set().

Referenced by AddFalse(), AddTrue(), Duplicate(), and ParseData().

This function adds a 64 bits floating point value to the ActionPushData object

Parameters:

[in]

value

The 64 bits floating point value

References ACTION_IMMEDIATE_TYPE_DOUBLE, f_data, sswf::ActionPushData::action_immediate_t::f_data, sswf::ActionPushData::action_immediate_t::f_float64, sswf::MemoryManager::MemAttach(), and sswf::Vectors::Set().

Referenced by Duplicate(), and ParseData().

This function is the same as AddString(NULL).

See also:

sswf::ActionPushData::AddString()

References AddString().

This function is the same as AddBoolean(false).

See also:

sswf::ActionPushData::AddBoolean()

References AddBoolean().

This function adds a 32 bits floating point to the ActionPushData object.

Parameters:

[in]

value

A 32 bits floating point value

References ACTION_IMMEDIATE_TYPE_FLOAT, f_data, sswf::ActionPushData::action_immediate_t::f_data, sswf::ActionPushData::action_immediate_t::f_float32, sswf::MemoryManager::MemAttach(), and sswf::Vectors::Set().

Referenced by Duplicate(), and ParseData().

This function adds a 32 bits integer to the ActionPushData

Parameters:

[in]

value

A 32 bits integer

References ACTION_IMMEDIATE_TYPE_INTEGER, f_data, sswf::ActionPushData::action_immediate_t::f_data, sswf::ActionPushData::action_immediate_t::f_integer32, sswf::MemoryManager::MemAttach(), and sswf::Vectors::Set().

Referenced by Duplicate(), and ParseData().

This function adds a string to the ActionPushData object. The index is the string index in this ActionScript dictionary.

Don't forget that you can have only one dictionary within one tag.

Parameters:

[in]

index

The index of the string to be added on the stack

References ACTION_IMMEDIATE_TYPE_LOOKUP, ACTION_IMMEDIATE_TYPE_LOOKUP_LARGE, f_data, sswf::ActionPushData::action_immediate_t::f_data, sswf::ActionPushData::action_immediate_t::f_lookup, sswf::MemoryManager::MemAttach(), and sswf::Vectors::Set().

Referenced by Duplicate(), and ParseData().

This function is used to add the special value NULL to an ActionPushData. This value is also called Nil in some ActionScripts. It represents a "no object reference".

References ACTION_IMMEDIATE_TYPE_NULL, f_data, sswf::MemoryManager::MemAttach(), and sswf::Vectors::Set().

Referenced by Duplicate(), and ParseData().

This function adds the content of the specified register. This is particularly useful for version 7+ functions which can save all their parameters in registers. Then you avoid an ActionGetVariable.

The register index is limited to 0, 1, 2 and 3 for the main script and any scripts before version 7. Since version 7, registers can be set from 0 to 254 within a function 2 declaration.

Parameters:

[in]

reg_index

The index of the register to read

References ACTION_IMMEDIATE_TYPE_REGISTER, f_data, sswf::ActionPushData::action_immediate_t::f_data, sswf::ActionPushData::action_immediate_t::f_register, sswf::MemoryManager::MemAttach(), and sswf::Vectors::Set().

Referenced by Duplicate(), and ParseData().

This function adds a string to the action.

See also:

sswf::ActionPushData::AddEmptyString()

Parameters:

[in]

string

The string to add to the action

References ACTION_IMMEDIATE_TYPE_STRING, f_data, sswf::ActionPushData::action_immediate_t::f_data, sswf::ActionPushData::action_immediate_t::f_string, sswf::MemoryManager::MemAttach(), sswf::Vectors::Set(), and sswf::MemoryManager::StrDup().

Referenced by AddEmptyString(), and Duplicate().

This function is the same as AddBoolean(true).

See also:

sswf::ActionPushData::AddBoolean()

References AddBoolean().

This function is used to add the special value Undefined to an ActionPushData. This is value is used to test whether some object, function, variable is defined or not.

It can also be used to pass as a parameter to a function which requires a parameter you cannot define.

References ACTION_IMMEDIATE_TYPE_UNDEFINED, f_data, sswf::MemoryManager::MemAttach(), and sswf::Vectors::Set().

Referenced by Duplicate(), and ParseData().

This function creates a new ActionPushData object and copies 'this' ActionPushData in it.

The function copies all the data which was added to the ActionPushData.

Returns:

The new ActionPushData pointer

Reimplemented from sswf::Action.

References ACTION_IMMEDIATE_TYPE_BOOLEAN, ACTION_IMMEDIATE_TYPE_DOUBLE, ACTION_IMMEDIATE_TYPE_FLOAT, ACTION_IMMEDIATE_TYPE_INTEGER, ACTION_IMMEDIATE_TYPE_LOOKUP, ACTION_IMMEDIATE_TYPE_LOOKUP_LARGE, ACTION_IMMEDIATE_TYPE_NULL, ACTION_IMMEDIATE_TYPE_REGISTER, ACTION_IMMEDIATE_TYPE_STRING, ACTION_IMMEDIATE_TYPE_UNDEFINED, ActionPushData(), AddBoolean(), AddDouble(), AddFloat(), AddInteger(), AddLookup(), AddNull(), AddRegister(), AddString(), AddUndefined(), sswf::assert(), sswf::Vectors::Count(), sswf::ActionPushData::action_immediate_t::f_boolean, sswf::ActionPushData::action_immediate_t::f_data, f_data, sswf::ActionPushData::action_immediate_t::f_float32, sswf::ActionPushData::action_immediate_t::f_float64, sswf::ActionPushData::action_immediate_t::f_integer32, sswf::ActionPushData::action_immediate_t::f_lookup, sswf::ActionPushData::action_immediate_t::f_register, sswf::ActionPushData::action_immediate_t::f_string, sswf::ActionPushData::action_immediate_t::f_type, sswf::Vectors::Get(), and sswf::Action::Tag().

This function defines what the largest register is in this ActionPushData.

Returns:

The largest register used in this ActionPushData

Reimplemented from sswf::Action.

References ACTION_IMMEDIATE_TYPE_BOOLEAN, ACTION_IMMEDIATE_TYPE_DOUBLE, ACTION_IMMEDIATE_TYPE_FLOAT, ACTION_IMMEDIATE_TYPE_INTEGER, ACTION_IMMEDIATE_TYPE_LOOKUP, ACTION_IMMEDIATE_TYPE_LOOKUP_LARGE, ACTION_IMMEDIATE_TYPE_NULL, ACTION_IMMEDIATE_TYPE_REGISTER, ACTION_IMMEDIATE_TYPE_STRING, ACTION_IMMEDIATE_TYPE_UNDEFINED, sswf::assert(), sswf::Vectors::Count(), sswf::ActionPushData::action_immediate_t::f_data, f_data, sswf::ActionPushData::action_immediate_t::f_register, sswf::ActionPushData::action_immediate_t::f_type, and sswf::Vectors::Get().

This function is used to save the actual data of the ActionPushData in the Data buffer.

Parameters:

[in]

data

The Data buffer from which the ActionPushData is read

Reimplemented from sswf::Action.

References ACTION_IMMEDIATE_TYPE_BOOLEAN, ACTION_IMMEDIATE_TYPE_DOUBLE, ACTION_IMMEDIATE_TYPE_FLOAT, ACTION_IMMEDIATE_TYPE_INTEGER, ACTION_IMMEDIATE_TYPE_LOOKUP, ACTION_IMMEDIATE_TYPE_LOOKUP_LARGE, ACTION_IMMEDIATE_TYPE_NULL, ACTION_IMMEDIATE_TYPE_REGISTER, ACTION_IMMEDIATE_TYPE_STRING, ACTION_IMMEDIATE_TYPE_UNDEFINED, AddBoolean(), AddDouble(), AddFloat(), AddInteger(), AddLookup(), AddNull(), AddRegister(), AddUndefined(), sswf::ErrorManager::ERROR_CODE_NONE, sswf::ErrorManager::ERROR_CODE_UNKNOWN_IMMEDIATE_DATA_TYPE, f_data, sswf::ActionPushData::action_immediate_t::f_data, sswf::ActionPushData::action_immediate_t::f_string, sswf::Data::GetByte(), sswf::Data::GetLong(), sswf::Data::GetLongFloat(), sswf::Data::GetShort(), sswf::Data::GetString(), sswf::Data::IsEndOfData(), sswf::MemoryManager::MemAttach(), sswf::Action::OnError(), and sswf::Vectors::Set().

This function is used to save the actual data of the ActionPushData in the Data buffer.

Parameters:

[in]	data	The Data buffer where the ActionPushData is saved
[in]	nested_data	There is no nested data in an ActionPushData

Reimplemented from sswf::Action.

References ACTION_IMMEDIATE_TYPE_BOOLEAN, ACTION_IMMEDIATE_TYPE_DOUBLE, ACTION_IMMEDIATE_TYPE_FLOAT, ACTION_IMMEDIATE_TYPE_INTEGER, ACTION_IMMEDIATE_TYPE_LOOKUP, ACTION_IMMEDIATE_TYPE_LOOKUP_LARGE, ACTION_IMMEDIATE_TYPE_NULL, ACTION_IMMEDIATE_TYPE_REGISTER, ACTION_IMMEDIATE_TYPE_STRING, ACTION_IMMEDIATE_TYPE_UNDEFINED, sswf::assert(), sswf::Vectors::Count(), sswf::ErrorManager::ERROR_CODE_INTERNAL_ERROR, sswf::ErrorManager::ERROR_CODE_NONE, sswf::ActionPushData::action_immediate_t::f_boolean, sswf::ActionPushData::action_immediate_t::f_data, f_data, sswf::ActionPushData::action_immediate_t::f_integer32, sswf::ActionPushData::action_immediate_t::f_lookup, sswf::ActionPushData::action_immediate_t::f_register, sswf::ActionPushData::action_immediate_t::f_string, sswf::ActionPushData::action_immediate_t::f_type, sswf::Vectors::Get(), sswf::ErrorManager::KeepFirst(), sswf::Action::OnError(), sswf::Data::PutByte(), sswf::Data::PutLong(), sswf::Data::PutShort(), and sswf::Action::SaveString().

Referenced by AddBoolean(), AddDouble(), AddFloat(), AddInteger(), AddLookup(), AddNull(), AddRegister(), AddString(), AddUndefined(), Duplicate(), GetMaxRegister(), ParseData(), and SaveData().