TorqueScript  0.2
Public Member Functions | List of all members
TorqueScript::Instructions::JumpTrueInstruction Class Reference

Jumps to the specified instruction offset if a condition is true. The condition checked is the value at the top of the stack coerced to a boolean. If the condition is false, this instruction only pops the stack. More...

#include <instructions.hpp>

Inheritance diagram for TorqueScript::Instructions::JumpTrueInstruction:
Inheritance graph
[legend]
Collaboration diagram for TorqueScript::Instructions::JumpTrueInstruction:
Collaboration graph
[legend]

Public Member Functions

 JumpTrueInstruction (const AddressType offset)
 Constructs a new instance of JumpTrueInstruction. More...
 
virtual AddressOffsetType execute (std::shared_ptr< ExecutionState > state) override
 Main execution method of the instruction. This serves as our switching statement that determines how opcodes will behave. More...
 
virtual std::string disassemble () override
 Helper routine to produce a disassembly for this instruction.
 

Additional Inherited Members

- Public Attributes inherited from TorqueScript::Instructions::Instruction
std::string mComment
 Compiler generated comment, used for generating easier to follow disassembly.
 

Detailed Description

Jumps to the specified instruction offset if a condition is true. The condition checked is the value at the top of the stack coerced to a boolean. If the condition is false, this instruction only pops the stack.

Constructor & Destructor Documentation

◆ JumpTrueInstruction()

TorqueScript::Instructions::JumpTrueInstruction::JumpTrueInstruction ( const AddressType  offset)
inline

Constructs a new instance of JumpTrueInstruction.

Parameters
offsetThe instruction offset to jump to if the condition is true.

Member Function Documentation

◆ execute()

virtual AddressOffsetType TorqueScript::Instructions::JumpTrueInstruction::execute ( std::shared_ptr< ExecutionState state)
inlineoverridevirtual

Main execution method of the instruction. This serves as our switching statement that determines how opcodes will behave.

Parameters
stateThe current execution state to act upon.

Implements TorqueScript::Instructions::Instruction.


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